Customers

My Account

Self-service endpoints used by the shopfront for the currently-authenticated Customer — viewing their charges, credits, memberships, contraindications, payment methods and marketing preferences.

get/customers/my-account

Get My Account Credits

listMyAccountCredits

Returns the unredeemed, unexpired credits available to the authenticated customer.

By default, only credits which haven't been redeemed and haven't expired are shown. Use the query parameters to include redeemed and/or expired credits. Revoked credits are never returned on this endpoint.

Query parameters

redeemedbooleanoptional
Whether to include redeemed credits
expiredbooleanoptional
Whether to include expired credits

Responses

200
The customer's credits were successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/customers/my-account/credits" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/my-account/credits', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/my-account/credits",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/my-account/credits', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/my-account/credits", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's credits were successfully retrieved

{
  "data": [
    {
      "id": "000000-000000-000000-000000",
      "coupon_name": "Free 30 minute massage",
      "coupon_description": "Enjoy a free 30 minute massage as a thanks for being a loyal member",
      "multi_use": true,
      "customer_id": "000000-000000-000000-000000",
      "membership_id": "000000-000000-000000-000000",
      "coupon_code": "string",
      "revenue": 2495,
      "issued_at": "2021-01-01T00:00:00.000Z",
      "expires_at": "2021-01-01T00:00:00.000Z",
      "redeemed_at": "2021-01-01T00:00:00.000Z",
      "revoked_at": "2026-01-15T09:30:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

get/customers/my-account/marketing-preferences

Get My Account Marketing Preferences

listMyAccountMarketingPreferences

Returns the marketing preferences available to the authenticated customer along with the opt-in state for each.

Responses

200
The customer's marketing preferences were successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/customers/my-account/marketing-preferences" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/my-account/marketing-preferences', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/my-account/marketing-preferences",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/my-account/marketing-preferences', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/my-account/marketing-preferences", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's marketing preferences were successfully retrieved

{
  "data": [
    {
      "id": "5dcb47800000000000000110",
      "marketing_preference": {
        "id": "00000000-0000-0000-0000-000000000000",
        "text": "I want to receive emails about special offers",
        "organisation_id": "00000000-0000-0000-0000-000000000000",
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      },
      "opted_in": true,
      "opted_in_at": "2020-02-24T12:00:00+00:00",
      "opted_out_at": "2020-02-24T12:00:00+00:00",
      "is_archived": true
    }
  ]
}

{
  "message": "Unauthenticated"
}

post/customers/my-account/marketing-preferences/{marketingPreferenceId}

Opt Into a Marketing Preference (My Account)

actionMyAccountMarketingPreferenceOptIn

Opts the authenticated customer into the given marketing preference.

Path parameters

marketingPreferenceIduuidrequired
The unique identifier of the marketing preference this operation is scoped to.

Responses

200
The customer's marketing preferences were successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's marketing preferences were successfully retrieved

{
  "data": [
    {
      "id": "5dcb47800000000000000110",
      "marketing_preference": {
        "id": "00000000-0000-0000-0000-000000000000",
        "text": "I want to receive emails about special offers",
        "organisation_id": "00000000-0000-0000-0000-000000000000",
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      },
      "opted_in": true,
      "opted_in_at": "2020-02-24T12:00:00+00:00",
      "opted_out_at": "2020-02-24T12:00:00+00:00",
      "is_archived": true
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

delete/customers/my-account/marketing-preferences/{marketingPreferenceId}

Opt Out of a Marketing Preference (My Account)

actionMyAccountMarketingPreferenceOptOut

Opts the authenticated customer out of the given marketing preference.

Path parameters

marketingPreferenceIduuidrequired
The unique identifier of the marketing preference this operation is scoped to.

Responses

200
The customer's marketing preferences were successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/customers/my-account/marketing-preferences/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's marketing preferences were successfully retrieved

{
  "data": [
    {
      "id": "5dcb47800000000000000110",
      "marketing_preference": {
        "id": "00000000-0000-0000-0000-000000000000",
        "text": "I want to receive emails about special offers",
        "organisation_id": "00000000-0000-0000-0000-000000000000",
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      },
      "opted_in": true,
      "opted_in_at": "2020-02-24T12:00:00+00:00",
      "opted_out_at": "2020-02-24T12:00:00+00:00",
      "is_archived": true
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/customers/my-account/memberships

Get My Account Memberships

listMyAccountMemberships

Returns the memberships held by the authenticated customer.

Responses

200
The customer's memberships were successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/customers/my-account/memberships" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/my-account/memberships', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/my-account/memberships",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/my-account/memberships', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/my-account/memberships", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's memberships were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "attention_reason": "no_mandate",
      "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "customer": {
        "id": "00000000-0000-0000-0000-000000000000",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "2026-01-15",
        "brand_id": "00000000-0000-0000-0000-000000000000",
        "site_id": "00000000-0000-0000-0000-000000000000",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "2026-01-15T09:30:00+00:00",
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00",
        "deleted_at": "2026-01-15T09:30:00+00:00",
        "last_active_at": "2026-01-15T09:30:00+00:00",
        "email_verified_at": "2026-01-15T09:30:00+00:00",
        "last_check_in": {
          "checked_in_at": "2026-01-15T09:30:00+00:00",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "00000000-0000-0000-0000-000000000000",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "ext-cust-789012"
      },
      "end_date": "2026-01-15T09:30:00+00:00",
      "external_ref": "EXT-12345",
      "members": [
        {
          "customer_id": "00000000-0000-0000-0000-000000000000",
          "is_lead": true,
          "membership_number": "1234567890"
        }
      ],
      "membership_number": "1234567890",
      "next_billing_date": "2026-01-15T09:30:00+00:00",
      "next_charge": {
        "id": "00000000-0000-0000-0000-000000000000",
        "amount": 3995,
        "currency": "GBP",
        "status": "awaiting_approval",
        "billing_period_from": "2026-01-15",
        "billing_period_to": "2026-01-15"
      },
      "payment_method": {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "card",
        "last_4": "string",
        "status": "revoked",
        "card_brand": "amex"
      },
      "rate": {
        "id": "00000000-0000-0000-0000-000000000000",
        "membership_type_id": "00000000-0000-0000-0000-000000000000",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "string"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00"
      },
      "site_id": "00000000-0000-0000-0000-000000000000",
      "source": "self_signup",
      "start_date": "2026-01-15T09:30:00+00:00",
      "status": "active",
      "status_updated_at": "2026-01-15T09:30:00+00:00",
      "type": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "string",
        "brand_id": "00000000-0000-0000-0000-000000000000",
        "offline_payments": false,
        "disable_confirmation_email": false,
        "private": false,
        "visibility": "public",
        "minimum_start_date": "2026-01-15T09:30:00+00:00",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "membership_type_id": "00000000-0000-0000-0000-000000000000",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "string"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "2026-01-15T09:30:00+00:00",
            "updated_at": "2026-01-15T09:30:00+00:00"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "2026-01-15T09:30:00+00:00",
        "updated_at": "2026-01-15T09:30:00+00:00",
        "deleted_at": "2026-01-15T09:30:00+00:00"
      },
      "payment_details_url": "https://example.com",
      "created_at": "2026-01-15T09:30:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

get/customers/my-account/payment-methods

Get My Account Payment Methods

listMyAccountPaymentMethods

Returns the payment methods saved against the authenticated customer.

Responses

200
The customer's payment methods were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/my-account/payment-methods" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/my-account/payment-methods', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/my-account/payment-methods",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/my-account/payment-methods', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/my-account/payment-methods", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's payment methods were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "payment_method_id": "pm_3K6a0RGysTOePye00nkob5Pi",
      "name": "My debit card",
      "type": "card",
      "status": "revoked",
      "cardholder_name": "Jane Doe",
      "card_brand": "amex",
      "card_country": "gb",
      "card_funding": "credit",
      "card_expiry": "08/22",
      "last_4": "1234",
      "processor": "stripe",
      "created_at": "2025-01-01T00:00:00+00:00",
      "updated_at": "2025-01-01T00:00:00+00:00",
      "revoked_at": "2025-01-01T00:00:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

get/shop/my-account/orders

List orders for the authenticated customer

listMyAccountOrders

Returns the authenticated customer's order history — completed baskets along with item details. Intended for the "My Bookings" screens of customer-facing apps and the storefront.

Requires customer authentication; staff API tokens cannot use this endpoint (use GET /shop/orders instead).

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
The Orders were successfully retrieved
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/my-account/orders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/my-account/orders', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/my-account/orders",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/my-account/orders', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/my-account/orders", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The `Order`s were successfully retrieved

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "applied_promo_code": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "applied_at": "2023-11-15T12:00:00+00:00",
        "applied_by": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "avatar": {
            "id": "00000000-0000-0000-0000-000000000000",
            "file_name": "super-cool-photo.jpg",
            "mime_type": "image/jpeg",
            "original_url": "https://example.com/media/super-cool-photo.jpg",
            "size": 84256,
            "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
          },
          "email": "guest@example.com",
          "first_name": "Jane",
          "full_name": "Jane Smith",
          "last_name": "Smith"
        },
        "code": "FIVEOFF",
        "discount_total": 2000,
        "is_discount_applied": true,
        "percentage": 10
      },
      "applied_promo_code_discount_total": 1,
      "applied_promo_code_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "booking_items": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "added_by_customer": false,
          "base_price": 1,
          "booking_reserved_until": "2026-01-15T09:30:00+00:00",
          "booking_summary": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "area_ids": [
              "64a9f3b2c3d8e1f4a5b6c7d8"
            ],
            "areas": [
              null
            ],
            "duration": 1,
            "end_time": "2026-01-15T09:30:00+00:00",
            "offering": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "start_time": "2026-01-15T09:30:00+00:00",
            "status": "cancelled",
            "created_at": "2025-02-04T12:00:00+01:00",
            "updated_at": "2025-02-04T12:00:00+01:00"
          },
          "date": "2026-01-15",
          "discount_amount": 1,
          "discounts": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "exclusive_tax_amount": 1,
          "guest": {
            "id": "5dcb47800000000000000000",
            "checked_in_at": "2025-10-01T12:00:00+00:00",
            "checked_out_at": "2025-10-01T16:30:00+00:00",
            "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
            "email": "jane.doe@example.com",
            "first_name": "Jane",
            "intake_form_submission_id": "5dcb47800000000000000010",
            "intake_form_complete": false,
            "is_lead_booker": true,
            "last_name": "Doe",
            "name": "Jane Doe"
          },
          "guests": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "inclusive_tax_amount": 1,
          "is_modifiable": true,
          "item_type": "appointment",
          "net_total": 1,
          "order_discount_amount": 1,
          "price": 1,
          "sold_by": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan",
            "type": "practitioner"
          },
          "status": "cancelled",
          "total_cost": 1,
          "type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type_name": "string",
          "type_product_code": "string",
          "created_at": "2025-02-04T12:00:00+01:00",
          "updated_at": "2025-02-04T12:00:00+01:00"
        }
      ],
      "booking_items_end_date": "2026-01-15",
      "booking_items_start_date": "2026-01-15",
      "booking_items_span_multiple_days": false,
      "coupon_codes": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "code": "FIVEOFF",
          "customer_credit_id": "00000000-0000-0000-0000-000000000000",
          "description": "Get 10% off all treatments booked in April.",
          "issued_by_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "issued_by_type": "credit",
          "name": "April special"
        }
      ],
      "currency": "gbp",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "customer_tax_details": {
        "legal_name": "Jane Jones",
        "tax_id": "GB1234567",
        "address_line_1": "1 Davey Street",
        "address_line_2": "Clapham",
        "city": "London",
        "postcode": "SW4 1AA",
        "country": "United Kingdom"
      },
      "discount_total": 100,
      "discounts": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "amount_type": "monetary",
          "applicable_for": "app_and_booking_engine",
          "applied_at": "2026-01-15T09:30:00+00:00",
          "applied_by": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "avatar": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "email": "guest@example.com",
            "first_name": "Jane",
            "full_name": "Jane Smith",
            "last_name": "Smith"
          },
          "calculated_amount": 150,
          "coupon": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "code": "FIVEOFF",
            "name": "April special",
            "description": "Get 10% off all treatments booked in April.",
            "customer_credit_id": "00000000-0000-0000-0000-000000000000"
          },
          "coupon_code_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "currency": "gbp",
          "discount_amount": 15,
          "discount_type_code": "SUMMER23",
          "reason_code": "general",
          "site_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "email": "janedoe@example.com",
      "external_ids": [
        {
          "key": "pms_id",
          "name": "PMS ID",
          "value": "pms_1234"
        }
      ],
      "external_ref": "ABC-123",
      "external_visit_ref": "RES1234",
      "first_name": "Jane",
      "guests": [
        {
          "id": "5dcb47800000000000000000",
          "checked_in_at": "2025-10-01T12:00:00+00:00",
          "checked_out_at": "2025-10-01T16:30:00+00:00",
          "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
          "email": "jane.doe@example.com",
          "first_name": "Jane",
          "intake_form_submission_id": "5dcb47800000000000000010",
          "intake_form_complete": false,
          "is_lead_booker": true,
          "last_name": "Doe",
          "name": "Jane Doe"
        }
      ],
      "intake_form_required": true,
      "intake_form_url": "https://demo.try.be/intake-form",
      "intake_forms_complete": true,
      "integration_config_id": "5f344d756e7f2e7d3f2e4b82",
      "is_customer_required": true,
      "is_locked": false,
      "is_promo_code_discount_applied": true,
      "items": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "added_by_customer": false,
          "base_price": 595,
          "basket_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "booking_summary": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "area_ids": [
              "64a9f3b2c3d8e1f4a5b6c7d8"
            ],
            "areas": [
              null
            ],
            "duration": 1,
            "end_time": "2026-01-15T09:30:00+00:00",
            "offering": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "start_time": "2026-01-15T09:30:00+00:00",
            "status": "cancelled",
            "created_at": "2025-02-04T12:00:00+01:00",
            "updated_at": "2025-02-04T12:00:00+01:00"
          },
          "discount_amount": 595,
          "discounts": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "exclusive_tax_amount": 0,
          "guests": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "has_posted": true,
          "inclusive_tax_amount": 49,
          "item_configuration": {},
          "last_post_attempt": "2026-01-15T09:30:00+00:00",
          "offering": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "name": "30 Minute Massage",
            "type": "appointment",
            "product_code": "string"
          },
          "option_budgets": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "order_discount_amount": 1,
          "package_items": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "posted_at": "2026-01-15T09:30:00+00:00",
          "price": 595,
          "purchasable_details": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "time_from": "2026-01-15T09:30:00+00:00",
            "time_to": "2026-01-15T09:30:00+00:00"
          },
          "quantity": 1,
          "reserved_until": "2026-01-15T09:30:00+00:00",
          "sold_by": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan",
            "type": "practitioner"
          },
          "status": "cancelled",
          "total_cost": 595,
          "created_at": "2025-02-04T12:00:00+01:00",
          "updated_at": "2025-02-04T12:00:00+01:00"
        }
      ],
      "items_status": "confirmed",
      "labels": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "color": "#FF0000",
          "name": "VIP",
          "order_id": "64a9f3b2c3d8e1f4a5b6c7d8"
        }
      ],
      "last_name": "Doe",
      "locked_at": "2019-01-15T12:00:00+01:00",
      "net_total": 8000,
      "order_ref": "TRY00",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "outstanding_payment_amount": 1,
      "package_items": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "added_by_customer": false,
          "base_price": 1,
          "date": "2026-01-15",
          "discount_amount": 1,
          "discounts": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "exclusive_tax_amount": 1,
          "guest": {
            "id": "5dcb47800000000000000000",
            "checked_in_at": "2025-10-01T12:00:00+00:00",
            "checked_out_at": "2025-10-01T16:30:00+00:00",
            "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
            "email": "jane.doe@example.com",
            "first_name": "Jane",
            "intake_form_submission_id": "5dcb47800000000000000010",
            "intake_form_complete": false,
            "is_lead_booker": true,
            "last_name": "Doe",
            "name": "Jane Doe"
          },
          "guests": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "inclusive_tax_amount": 1,
          "integration_booking_engine": "Guestline",
          "is_modifiable": true,
          "item_type": "package",
          "net_total": 1,
          "option_budgets": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "order_discount_amount": 1,
          "package_items": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "price": 1,
          "sold_by": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan",
            "type": "practitioner"
          },
          "status": "cancelled",
          "total_cost": 1,
          "type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type_name": "string",
          "type_product_code": "string",
          "created_at": "2025-02-04T12:00:00+01:00",
          "updated_at": "2025-02-04T12:00:00+01:00"
        }
      ],
      "payment_totals": {
        "chargeable": 500,
        "missing": 1000,
        "paid": 750,
        "pending": 250,
        "provided": 1500,
        "unpaid": 1000
      },
      "payments": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "amount": 10000,
          "capture_method": "automatic",
          "chargebacks": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "currency": "gbp",
          "details_source": "pay_by_link",
          "failure_reason": "Suspected fraud",
          "order_ref": "EXT-12345",
          "paid_at": "2020-02-24T12:00:00+01:00",
          "payable_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "payable_type": "string",
          "processor": "stripe",
          "processor_data": {},
          "processor_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "processor_type": "string",
          "refundable_amount": 3500,
          "refunds": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "status": "cancelled",
          "created_at": "2025-02-04T12:00:00+01:00"
        }
      ],
      "phone": "+447727123456",
      "post_to_room_config": {
        "associated_at": "2026-01-15T09:30:00+00:00",
        "processor_data": {
          "G#": 2081111,
          "RN": "9500"
        }
      },
      "promo_code_applied_at": "2026-01-15T09:30:00+00:00",
      "promo_code_applied_by": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "avatar": {
          "id": "00000000-0000-0000-0000-000000000000",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "email": "guest@example.com",
        "first_name": "Jane",
        "full_name": "Jane Smith",
        "last_name": "Smith"
      },
      "purchase_items": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "added_by_customer": false,
          "base_price": 1,
          "discount_amount": 1,
          "discounts": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "exclusive_tax_amount": 1,
          "guests": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "inclusive_tax_amount": 1,
          "is_modifiable": true,
          "item_configuration": {},
          "item_type": "product",
          "net_total": 1,
          "order_discount_amount": 1,
          "purchasable_details": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8"
          },
          "quantity": 1,
          "reserved_until": "2026-01-15T09:30:00+00:00",
          "sold_by": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Alex Morgan",
            "type": "practitioner"
          },
          "status": "cancelled",
          "total_cost": 1,
          "type_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type_name": "string",
          "type_product_code": "string",
          "unit_price": 1,
          "created_at": "2025-02-04T12:00:00+01:00",
          "updated_at": "2025-02-04T12:00:00+01:00"
        }
      ],
      "sales_channel": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "name": "Web",
        "organisation_id": "00000000-0000-0000-0000-000000000000"
      },
      "service_charge": {
        "amount": 1000,
        "item_amounts": [
          {
            "amount": 1000,
            "item_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "percentage": 10
          }
        ],
        "percentage": 10
      },
      "site_id": "00000000-0000-0000-0000-000000000000",
      "special_requests": "I would like the Blue Room please",
      "stage": "not_arrived",
      "status": "submitted",
      "submit_auth_amount": 1,
      "submit_payment_amount": 1,
      "submitted_at": "2020-02-24T12:00:00+01:00",
      "submitted_by": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "avatar": {
          "id": "00000000-0000-0000-0000-000000000000",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "email": "guest@example.com",
        "first_name": "Jane",
        "full_name": "Jane Smith",
        "last_name": "Smith"
      },
      "taxes": [
        {
          "amount": 1290,
          "inclusive": false,
          "name": "VAT",
          "percentage": 20
        }
      ],
      "tip_amount": 1050,
      "tips": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "amount": 1050,
          "declined": false,
          "updated_at": "2026-01-15T09:30:00+00:00",
          "can_remove": false
        }
      ],
      "total_cost": 1,
      "total_paid_or_authed": 1,
      "total_tax": 2000,
      "totals": {
        "exclusive_tax": 0,
        "inclusive_tax": 250,
        "order_discount": 11000,
        "subtotal": 12000,
        "subtotal_without_exclusive_tax": 12000,
        "total": 10000
      },
      "visit": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "visit_ref": "EXT-12345",
        "visit_type": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Stay"
        },
        "status": "string",
        "arrival_date": "2026-01-15T09:30:00+00:00",
        "departure_date": "2026-01-15T09:30:00+00:00",
        "first_name": "Alex",
        "last_name": "Morgan"
      },
      "voucher_codes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "amount_type": "discount_to_zero",
          "calculated_amount": 1000,
          "code": "ABCDEFGHIJ123",
          "coupon_code_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "description": "A 30 minute treatment of your choice.",
          "is_redeemed": true,
          "name": "30 min treatment",
          "voucher_type_id": "64a9f3b2c3d8e1f4a5b6c7d8"
        }
      ],
      "created_at": "2020-02-24T12:00:00+01:00",
      "updated_at": "2020-02-24T12:00:00+01:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

My Account

Get My Account Details

Responses

Get My Account Charges

Responses

Get My Account Credits

Query parameters

Responses

Get My Account Marketing Preferences

Responses

Opt Into a Marketing Preference (My Account)

Path parameters

Responses

Opt Out of a Marketing Preference (My Account)

Path parameters

Responses

Get My Account Memberships

Responses

Get My Account Payment Methods

Responses

List orders for the authenticated customer

Query parameters

Responses