Customers

A Customer represents a guest at a Trybe site.

A Customer is created when a guest creates an account on a Trybe shopfront, places a booking, or is created manually in the Trybe app.

The Customer object

Attributes

iduuidrequired
The ID of the customer.
first_namestringrequirednullable
The first name of the customer.
last_namestringrequirednullable
The last name of the customer.
full_namestringrequirednullable
The customer's full name
phonestringrequirednullable
The customer's phone number in E.164 format, or null if not provided.
has_passwordbooleanrequired
Whether the user has a password
dobdaterequirednullable
The customer's date of birth in YYYY-MM-DD format, or null if not provided.
brand_iduuidrequired
The ID of the brand this customer belongs to
site_iduuidrequired
Identifier of the site the customer was created at. Customer records are scoped per site so each location's CRM data is isolated; cross-site reporting is available via the brand or organisation.
stripe_idstringrequirednullable
The Stripe Customer ID for this customer
express_stripe_idstringrequirednullable
The Stripe Customer ID for this customer if they also exist in Trybe's legacy Stripe integration
emailstringrequirednullable
The email address of the customer.

The case of the email address is not preserved, so you'll always see this in lowercase.
labelsobject[]required
An array of labels associated with this customer
preferred_localestringrequired
The preferred locale of the customer.

This must be one of the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.
locked_atdate-timerequirednullable
The datetime which the customer was locked, or null if it has not been locked.
created_atdate-timerequired
The datetime which the customer was created
updated_atdate-timerequired
The datetime which the customer was last updated
deleted_atdate-timerequirednullable
The datetime which the customer was anonymised, or null if it has not been.
last_active_atdate-timerequirednullable
The datetime which the customer was last active
email_verified_atdate-timerequirednullable
The datetime which the customer verified their email address
last_check_inobjectrequirednullable
A summary of the last check-in event associated with this customer, or null if they have never checked-in.
avatar_iduuidrequirednullable
The media ID of the customer's avatar, or null if one hasn't been provided.
avatarrequirednullable
The media object of the customer's avatar, or null if one hasn't been provided.
external_refstringrequirednullable
An external reference for this 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": "string",
  "external_ref": "ext-cust-789012"
}

get/shop/customers/search

Get stats for a single customer across the whole organisation

getCustomerStats

Use this endpoint to retrieve high-level stats for a single customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
Customer stats were found
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/stats" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/stats', {
  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/customers/00000000-0000-0000-0000-000000000000/stats",
    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/customers/00000000-0000-0000-0000-000000000000/stats', [
    '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/customers/00000000-0000-0000-0000-000000000000/stats", 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)
}

Customer stats were found

{
  "data": {
    "totals": {
      "total_order_value": 38500,
      "average_order_value": 19250,
      "num_orders": 2
    },
    "recent_orders": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "order_ref": "EXT-12345",
        "status": "submitted",
        "num_items": 2,
        "customer": {
          "id": "00000000-0000-0000-0000-000000000000",
          "email": "jane@example.com",
          "first_name": "Jane",
          "last_name": "Jones"
        },
        "sales_channel": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "name": "Website"
        },
        "totals": {
          "subtotal": 15000,
          "order_discount": 0,
          "total": 15000
        },
        "submitted_at": "2026-01-15T09:30:00+00:00",
        "site": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Palm Tree Spa"
        }
      }
    ]
  },
  "meta": {
    "currency": "gbp"
  }
}

{
  "message": "Unauthenticated"
}

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

get/customers/customers

Update a Customer

updateCustomer

Use this endpoint to update an existing Customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Request body

first_namestringoptionalnullable
The first name of the customer.
last_namestringoptionalnullable
The last name of the customer.
phonestringoptionalnullable
The customer's phone number in E.164 format, or null if not provided.
dobdateoptionalnullable
The customer's date of birth in YYYY-MM-DD format, or null if not provided.
passwordpasswordoptional
The customer's password. This must be at least 8 characters long
external_refstringoptionalnullable
An external reference for this customer.
preferred_localestringoptional
The preferred locale of the customer.

This must be one of the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.

Responses

201
The Customer was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "+447900000000",
  "dob": "2026-01-15",
  "password": "password",
  "external_ref": "ext-cust-789012",
  "preferred_locale": "en"
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "+447900000000",
    "dob": "2026-01-15",
    "password": "password",
    "external_ref": "ext-cust-789012",
    "preferred_locale": "en"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "first_name": "Jane",
        "last_name": "Doe",
        "phone": "+447900000000",
        "dob": "2026-01-15",
        "password": "password",
        "external_ref": "ext-cust-789012",
        "preferred_locale": "en"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'first_name' => 'Jane',
            'last_name' => 'Doe',
            'phone' => '+447900000000',
            'dob' => '2026-01-15',
            'password' => 'password',
            'external_ref' => 'ext-cust-789012',
            'preferred_locale' => 'en'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"first_name": "Jane",
		"last_name": "Doe",
		"phone": "+447900000000",
		"dob": "2026-01-15",
		"password": "password",
		"external_ref": "ext-cust-789012",
		"preferred_locale": "en",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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` was successfully retrieved

{
  "data": {
    "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"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/customers/customers/{customerId}

Delete a Customer

deleteCustomer

Anonymises the given Customer. The customer record is retained for accounting and reporting purposes but personally identifiable information is scrubbed.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

204
The customer was successfully anonymised
400
The customer could not be anonymised
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/customers/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/customers/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/customers/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/customers/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/customers/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 was successfully anonymised

// empty response

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/shop/customers/{customerId}/barcodes

List Associated Barcodes for a Customer

listAssociatedBarcodes

This endpoint retrieves all barcodes associated with a customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Query parameters

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

Responses

200
The barcodes associated with the customer were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes', {
  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/customers/00000000-0000-0000-0000-000000000000/barcodes",
    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/customers/00000000-0000-0000-0000-000000000000/barcodes', [
    '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/customers/00000000-0000-0000-0000-000000000000/barcodes", 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 barcodes associated with the customer were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "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"
      },
      "barcode": "string",
      "expires_at": "2026-01-15T09:30:00+00:00",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "source": "kiosk",
      "order": {
        "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"
            },
            "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": "00000000-0000-0000-0000-000000000000"
            },
            "date": "2026-01-15",
            "discount_amount": 1,
            "discounts": [
              null
            ],
            "exclusive_tax_amount": 1,
            "guest": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "guests": [
              null
            ],
            "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"
            },
            "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": "00000000-0000-0000-0000-000000000000"
            },
            "calculated_amount": 150,
            "coupon": {
              "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": "00000000-0000-0000-0000-000000000000"
            },
            "discount_amount": 595,
            "discounts": [
              null
            ],
            "exclusive_tax_amount": 0,
            "guests": [
              null
            ],
            "has_posted": true,
            "inclusive_tax_amount": 49,
            "item_configuration": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "last_post_attempt": "2026-01-15T09:30:00+00:00",
            "offering": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "option_budgets": [
              null
            ],
            "order_discount_amount": 1,
            "package_items": [
              null
            ],
            "posted_at": "2026-01-15T09:30:00+00:00",
            "price": 595,
            "purchasable_details": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "quantity": 1,
            "reserved_until": "2026-01-15T09:30:00+00:00",
            "sold_by": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "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": [
              null
            ],
            "exclusive_tax_amount": 1,
            "guest": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "guests": [
              null
            ],
            "inclusive_tax_amount": 1,
            "integration_booking_engine": "Guestline",
            "is_modifiable": true,
            "item_type": "package",
            "net_total": 1,
            "option_budgets": [
              null
            ],
            "order_discount_amount": 1,
            "package_items": [
              null
            ],
            "price": 1,
            "sold_by": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "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": [
              null
            ],
            "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": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "processor_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "processor_type": "string",
            "refundable_amount": 3500,
            "refunds": [
              null
            ],
            "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": [
              null
            ],
            "exclusive_tax_amount": 1,
            "guests": [
              null
            ],
            "inclusive_tax_amount": 1,
            "is_modifiable": true,
            "item_configuration": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "item_type": "product",
            "net_total": 1,
            "order_discount_amount": 1,
            "purchasable_details": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "quantity": 1,
            "reserved_until": "2026-01-15T09:30:00+00:00",
            "sold_by": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "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": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "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"
      },
      "payment_method": {
        "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"
      },
      "created_at": "2026-01-15T09:30:00+00: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": "Unauthenticated"
}

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

delete/shop/customers/{customerId}/barcodes/{barcodeId}

Delete an associated barcode for a customer

deleteAssociatedBarcode

This endpoint deletes an associated barcode for a customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
barcodeIdstringrequired
The ID of the barcode

Responses

204
The associated barcode was successfully deleted
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/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123', {
  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/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123",
    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/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123', [
    '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/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123", 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 associated barcode was successfully deleted

// empty response

{
  "message": "Unauthenticated"
}

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

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

put/shop/customers/{customerId}/barcodes/{barcodeId}

Update an associated barcode for a customer

updateAssociatedBarcode

This endpoint updates the details of an associated barcode for a customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
barcodeIdstringrequired
The ID of the barcode

Request body

payment_method_iduuidoptionalnullable
Identifier of the customer's saved payment method to attach to this wearable/access barcode. The barcode can then be used to pay at any in-resort POS via "charge to card on file". Pass null to clear the attachment.
order_idobject-idoptionalnullable
Identifier of an in-progress order to attach to this barcode. Lets a scanned barcode pull up the linked order at the POS (for example to keep adding items during a spa visit). Pass null to detach.
expires_atdate-timeoptionalnullable
The expiry date to set for the associated barcode.

Responses

200
The associated barcode was successfully updated
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "payment_method_id": "00000000-0000-0000-0000-000000000000",
  "order_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "expires_at": "2026-01-15T09:30:00+00:00"
}'

const response = await fetch('https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "payment_method_id": "00000000-0000-0000-0000-000000000000",
    "order_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "expires_at": "2026-01-15T09:30:00+00:00"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "payment_method_id": "00000000-0000-0000-0000-000000000000",
        "order_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "expires_at": "2026-01-15T09:30:00+00:00"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'payment_method_id' => '00000000-0000-0000-0000-000000000000',
            'order_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'expires_at' => '2026-01-15T09:30:00+00:00'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"payment_method_id": "00000000-0000-0000-0000-000000000000",
		"order_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"expires_at": "2026-01-15T09:30:00+00:00",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/customers/00000000-0000-0000-0000-000000000000/barcodes/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 associated barcode was successfully updated

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "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"
    },
    "barcode": "string",
    "expires_at": "2026-01-15T09:30:00+00:00",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "source": "kiosk",
    "order": {
      "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"
    },
    "payment_method": {
      "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"
    },
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/customers/customers/{customerId}/memberships

List a customer's memberships

getCustomerMemberships

Use this endpoint to retrieve a list of Memberships for the given Customer.

When retrieving memberships with this endpoint, the next_charge property will be populated if applicable.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

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

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

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/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/customers/00000000-0000-0000-0000-000000000000/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/customers/00000000-0000-0000-0000-000000000000/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/customers/00000000-0000-0000-0000-000000000000/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 `Membership`s 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"
    }
  ],
  "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": "Unauthenticated"
}

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

post/customers/customers/{customerId}/lock

Lock a Customer

actionLockCustomer

Use this endpoint to lock a Customer.

When a customer is locked, their details cannot be modified until their profile is unlocked.

Any requests to updateCustomer or anonymiseCustomer will fail with a 400 response.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The Customer was successfully retrieved
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/lock', {
  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/customers/00000000-0000-0000-0000-000000000000/lock",
    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/customers/00000000-0000-0000-0000-000000000000/lock', [
    '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/customers/00000000-0000-0000-0000-000000000000/lock", 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` was successfully retrieved

{
  "data": {
    "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"
  }
}

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

post/customers/customers/{customerId}/unlock

Unlock a Customer

actionUnlockCustomer

Use this endpoint to unlock a Customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The Customer was successfully retrieved
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/unlock', {
  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/customers/00000000-0000-0000-0000-000000000000/unlock",
    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/customers/00000000-0000-0000-0000-000000000000/unlock', [
    '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/customers/00000000-0000-0000-0000-000000000000/unlock", 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` was successfully retrieved

{
  "data": {
    "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"
  }
}

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

post/customers/customers/{customerId}/reset-password

Trigger reset password

actionTriggerCustomerPasswordReset

Use this endpoint to trigger a password reset for a Customer.

The customer will receive a URL via email which they can use to reset their password.

The URL will be valid for 1 hour.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The Customer was successfully retrieved
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/reset-password', {
  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/customers/00000000-0000-0000-0000-000000000000/reset-password",
    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/customers/00000000-0000-0000-0000-000000000000/reset-password', [
    '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/customers/00000000-0000-0000-0000-000000000000/reset-password", 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` was successfully retrieved

{
  "data": {
    "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"
  }
}

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

post/customers/customers/{customerId}/resend-verification

Resend verification

actionResendCustomerVerification

Use this endpoint to resend the email verification email for a Customer.

The customer will receive a URL via email which they can use to verify their email address.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The Customer was successfully retrieved
404
The resource couldn't be found

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

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/resend-verification', {
  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/customers/00000000-0000-0000-0000-000000000000/resend-verification",
    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/customers/00000000-0000-0000-0000-000000000000/resend-verification', [
    '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/customers/00000000-0000-0000-0000-000000000000/resend-verification", 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` was successfully retrieved

{
  "data": {
    "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"
  }
}

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

get/customers/customers/{customerId}/addresses

List a Customer's Addresses

listCustomerAddresses

Retrieves a paginated list of addresses belonging to the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Query parameters

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

Responses

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

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses', {
  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/customers/00000000-0000-0000-0000-000000000000/addresses",
    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/customers/00000000-0000-0000-0000-000000000000/addresses', [
    '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/customers/00000000-0000-0000-0000-000000000000/addresses", 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 addresses were successfully retrieved

{
  "data": [
    {
      "id": "000000-000000-000000-000000",
      "name": "Home",
      "address_line_1": "123 Fake Street",
      "address_line_2": "Some Building",
      "city": "London",
      "county": "London",
      "country": "United Kingdom",
      "country_code": "GB",
      "postcode": "E14 1AA"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

{
  "message": "Unauthenticated"
}

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

post/customers/customers/{customerId}/addresses

Create an Address for a Customer

createCustomerAddress

Creates a new postal address for the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Request body

namestringrequired
Short label the customer uses to identify the address — shown in address pickers at checkout. Typical values are Home, Work or a contact name.
address_line_1stringrequired
First line of the postal address — usually the street number and street name. Required because postal carriers cannot deliver without it.
address_line_2stringoptionalnullable
Optional second line of the postal address, used for suite/apartment numbers or building names that don't fit on address_line_1.
citystringoptionalnullable
City or town the address sits in. Optional because some rural addresses don't use a city line; when omitted the postcode is used for delivery routing.
countystringoptionalnullable
County, state or province. Optional in regions where the postcode alone uniquely identifies a delivery area.
countrystringoptionalnullable
Country the address is in. Free text rather than an ISO code so the customer can match the wording used on their shipping documents.
postcodestringoptionalnullable
Postal/ZIP code for the address. Optional because some countries don't use postcodes, but strongly recommended for delivery routing where they exist.

Responses

201
The customer's address was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Home",
  "address_line_1": "123 Fake Street",
  "address_line_2": "Some building",
  "city": "London",
  "county": "London",
  "country": "United Kingdom",
  "postcode": "E14 1AA"
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Home",
    "address_line_1": "123 Fake Street",
    "address_line_2": "Some building",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "postcode": "E14 1AA"
  }),
})

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/customers/00000000-0000-0000-0000-000000000000/addresses",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Home",
        "address_line_1": "123 Fake Street",
        "address_line_2": "Some building",
        "city": "London",
        "county": "London",
        "country": "United Kingdom",
        "postcode": "E14 1AA"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Home',
            'address_line_1' => '123 Fake Street',
            'address_line_2' => 'Some building',
            'city' => 'London',
            'county' => 'London',
            'country' => 'United Kingdom',
            'postcode' => 'E14 1AA'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Home",
		"address_line_1": "123 Fake Street",
		"address_line_2": "Some building",
		"city": "London",
		"county": "London",
		"country": "United Kingdom",
		"postcode": "E14 1AA",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 address was successfully retrieved

{
  "data": {
    "id": "000000-000000-000000-000000",
    "name": "Home",
    "address_line_1": "123 Fake Street",
    "address_line_2": "Some Building",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "country_code": "GB",
    "postcode": "E14 1AA"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/customers/customers/{customerId}/addresses/{addressId}

Get a Customer Address

getCustomerAddress

Retrieves a specific address belonging to the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
addressIduuidrequired
The unique identifier of the address this operation is scoped to.

Responses

200
The customer's address was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/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/customers/00000000-0000-0000-0000-000000000000/addresses/00000000-0000-0000-0000-000000000000', {
  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/customers/00000000-0000-0000-0000-000000000000/addresses/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('GET', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/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("GET", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/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 address was successfully retrieved

{
  "data": {
    "id": "000000-000000-000000-000000",
    "name": "Home",
    "address_line_1": "123 Fake Street",
    "address_line_2": "Some Building",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "country_code": "GB",
    "postcode": "E14 1AA"
  }
}

{
  "message": "Unauthenticated"
}

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

put/customers/customers/{customerId}/addresses/{addressId}

Update a Customer Address

updateCustomerAddress

Updates an existing address belonging to the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
addressIduuidrequired
The unique identifier of the address this operation is scoped to.

Request body

namestringoptional
Replacement label the customer uses to identify the address. Shown in address pickers at checkout.
address_line_1stringoptional
Replacement first line of the postal address — usually the street number and street name.
address_line_2stringoptionalnullable
Replacement second line of the postal address, used for suite/apartment numbers or building names. Pass null to clear.
citystringoptionalnullable
Replacement city or town for the address. Pass null to clear.
countystringoptionalnullable
Replacement county, state or province. Pass null to clear.
countrystringoptionalnullable
Replacement country for the address. Free text rather than an ISO code. Pass null to clear.
postcodestringoptionalnullable
Replacement postal/ZIP code for the address. Pass null to clear.

Responses

200
The customer's address was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Home",
  "address_line_1": "123 Fake Street",
  "address_line_2": "Some building",
  "city": "London",
  "county": "London",
  "country": "United Kingdom",
  "postcode": "E14 1AA"
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Home",
    "address_line_1": "123 Fake Street",
    "address_line_2": "Some building",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "postcode": "E14 1AA"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Home",
        "address_line_1": "123 Fake Street",
        "address_line_2": "Some building",
        "city": "London",
        "county": "London",
        "country": "United Kingdom",
        "postcode": "E14 1AA"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Home',
            'address_line_1' => '123 Fake Street',
            'address_line_2' => 'Some building',
            'city' => 'London',
            'county' => 'London',
            'country' => 'United Kingdom',
            'postcode' => 'E14 1AA'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Home",
		"address_line_1": "123 Fake Street",
		"address_line_2": "Some building",
		"city": "London",
		"county": "London",
		"country": "United Kingdom",
		"postcode": "E14 1AA",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/addresses/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 address was successfully retrieved

{
  "data": {
    "id": "000000-000000-000000-000000",
    "name": "Home",
    "address_line_1": "123 Fake Street",
    "address_line_2": "Some Building",
    "city": "London",
    "county": "London",
    "country": "United Kingdom",
    "country_code": "GB",
    "postcode": "E14 1AA"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/customers/customers/{customerId}/addresses/{addressId}

Delete a Customer Address

deleteCustomerAddress

Deletes the given address from the customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
addressIduuidrequired
The unique identifier of the address this operation is scoped to.

Responses

204
The address was successfully deleted
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/customers/00000000-0000-0000-0000-000000000000/addresses/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/customers/00000000-0000-0000-0000-000000000000/addresses/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/customers/00000000-0000-0000-0000-000000000000/addresses/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/customers/00000000-0000-0000-0000-000000000000/addresses/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/customers/00000000-0000-0000-0000-000000000000/addresses/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 address was successfully deleted

// empty response

{
  "message": "Unauthenticated"
}

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

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

get/customers/customers/{customerId}/barcodes

List Associated Barcodes

listCustomerAssociatedBarcodes

Retrieves the barcodes associated with the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The associated barcodes were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes', {
  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/customers/00000000-0000-0000-0000-000000000000/barcodes",
    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/customers/00000000-0000-0000-0000-000000000000/barcodes', [
    '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/customers/00000000-0000-0000-0000-000000000000/barcodes", 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 associated barcodes were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "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"
      },
      "barcode": "string",
      "expires_at": "2026-01-15T09:30:00+00:00",
      "brand_id": "00000000-0000-0000-0000-000000000000",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "organisation_id": "00000000-0000-0000-0000-000000000000",
      "source": "kiosk",
      "order": {
        "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"
            },
            "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": "00000000-0000-0000-0000-000000000000"
            },
            "date": "2026-01-15",
            "discount_amount": 1,
            "discounts": [
              null
            ],
            "exclusive_tax_amount": 1,
            "guest": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "guests": [
              null
            ],
            "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"
            },
            "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": "00000000-0000-0000-0000-000000000000"
            },
            "calculated_amount": 150,
            "coupon": {
              "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": "00000000-0000-0000-0000-000000000000"
            },
            "discount_amount": 595,
            "discounts": [
              null
            ],
            "exclusive_tax_amount": 0,
            "guests": [
              null
            ],
            "has_posted": true,
            "inclusive_tax_amount": 49,
            "item_configuration": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "last_post_attempt": "2026-01-15T09:30:00+00:00",
            "offering": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "option_budgets": [
              null
            ],
            "order_discount_amount": 1,
            "package_items": [
              null
            ],
            "posted_at": "2026-01-15T09:30:00+00:00",
            "price": 595,
            "purchasable_details": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "quantity": 1,
            "reserved_until": "2026-01-15T09:30:00+00:00",
            "sold_by": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "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": [
              null
            ],
            "exclusive_tax_amount": 1,
            "guest": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "guests": [
              null
            ],
            "inclusive_tax_amount": 1,
            "integration_booking_engine": "Guestline",
            "is_modifiable": true,
            "item_type": "package",
            "net_total": 1,
            "option_budgets": [
              null
            ],
            "order_discount_amount": 1,
            "package_items": [
              null
            ],
            "price": 1,
            "sold_by": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "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": [
              null
            ],
            "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": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "processor_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "processor_type": "string",
            "refundable_amount": 3500,
            "refunds": [
              null
            ],
            "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": [
              null
            ],
            "exclusive_tax_amount": 1,
            "guests": [
              null
            ],
            "inclusive_tax_amount": 1,
            "is_modifiable": true,
            "item_configuration": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "item_type": "product",
            "net_total": 1,
            "order_discount_amount": 1,
            "purchasable_details": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "quantity": 1,
            "reserved_until": "2026-01-15T09:30:00+00:00",
            "sold_by": {
              "id": "00000000-0000-0000-0000-000000000000"
            },
            "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": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "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"
      },
      "payment_method": {
        "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"
      },
      "created_at": "2026-01-15T09:30:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

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

post/customers/customers/{customerId}/barcodes

Associate a Barcode with a Customer

createCustomerBarcode

Associates the given barcode with the customer. Once associated, the barcode can be used to identify the customer at point-of-sale and kiosk-style integrations.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Request body

dataobjectrequired

Responses

200
The associated barcode was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "barcode": "string",
    "expires_at": "2021-03-10T00:00:00+00:00"
  }
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "data": {
      "barcode": "string",
      "expires_at": "2021-03-10T00:00:00+00:00"
    }
  }),
})

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/customers/00000000-0000-0000-0000-000000000000/barcodes",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "data": {
            "barcode": "string",
            "expires_at": "2021-03-10T00:00:00+00:00"
        }
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'data' => [
                'barcode' => 'string',
                'expires_at' => '2021-03-10T00:00:00+00:00'
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"data": map[string]interface{}{
			"barcode": "string",
			"expires_at": "2021-03-10T00:00:00+00:00",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 associated barcode was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "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"
    },
    "barcode": "string",
    "expires_at": "2026-01-15T09:30:00+00:00",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "source": "kiosk",
    "order": {
      "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"
    },
    "payment_method": {
      "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"
    },
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/customers/customers/{customerId}/barcodes/{barcodeId}

Get an Associated Barcode

getCustomerAssociatedBarcode

Retrieves the given barcode associated with the customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
barcodeIduuidrequired
The unique identifier of the associated barcode this operation is scoped to.

Responses

200
The associated barcode was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/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/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000', {
  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/customers/00000000-0000-0000-0000-000000000000/barcodes/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('GET', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/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("GET", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/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 associated barcode was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "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"
    },
    "barcode": "string",
    "expires_at": "2026-01-15T09:30:00+00:00",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "source": "kiosk",
    "order": {
      "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"
    },
    "payment_method": {
      "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"
    },
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

delete/customers/customers/{customerId}/barcodes/{barcodeId}

Disassociate a Barcode from a Customer

deleteCustomerBarcode

Removes the association between the given barcode and customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
barcodeIduuidrequired
The unique identifier of the associated barcode this operation is scoped to.

Responses

204
The barcode was successfully disassociated
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/customers/00000000-0000-0000-0000-000000000000/barcodes/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/customers/00000000-0000-0000-0000-000000000000/barcodes/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/customers/00000000-0000-0000-0000-000000000000/barcodes/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/customers/00000000-0000-0000-0000-000000000000/barcodes/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/customers/00000000-0000-0000-0000-000000000000/barcodes/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 barcode was successfully disassociated

// empty response

{
  "message": "Unauthenticated"
}

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

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

post/customers/customers/{customerId}/set-password-url

Generate a Set-Password URL

createSetPasswordUrl

Generates a one-time URL that can be sent to the customer for them to set or reset their password. The token included in the URL is valid for a limited time.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The URL to set the password was successfully generated
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/customers/00000000-0000-0000-0000-000000000000/set-password-url" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/set-password-url', {
  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/customers/00000000-0000-0000-0000-000000000000/set-password-url",
    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/customers/00000000-0000-0000-0000-000000000000/set-password-url', [
    '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/customers/00000000-0000-0000-0000-000000000000/set-password-url", 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 URL to set the password was successfully generated

{
  "data": {
    "token": "string",
    "url": "https://example.com"
  }
}

{
  "message": "Unauthenticated"
}

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

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

get/customers/customers/barcode-search/{code}

Search for a Customer by Barcode

getCustomerByBarcode

Looks up a customer by an associated barcode payload (or by their customer ID).

Path parameters

codestringrequired
The barcode to search for. This could either be the ID of the customer or an associated barcode.

Query parameters

site_idstringrequired
The site ID to scope the search to.

Responses

200
The Customer was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/barcode-search/value?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/barcode-search/value?site_id=site_abc123', {
  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/customers/barcode-search/value?site_id=site_abc123",
    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/customers/barcode-search/value?site_id=site_abc123', [
    '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/customers/barcode-search/value?site_id=site_abc123", 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` was successfully retrieved

{
  "data": {
    "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"
  }
}

{
  "message": "Unauthenticated"
}

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

get/customers/customers/queue

Queue a Report of Customers

queueListCustomers

Retrieves a report of customers in CSV format. The report will be generated asynchronously.

Query parameters

querystringoptional
Filters customers with a similar name, email or phone number to the given value
emailemailoptional
Filter customers with the given email address
organisation_iduuidoptional
Filter customers that belong to the given organisation ID
brand_iduuidoptional
Filter customers that belong to the given brand ID
membership_numberstringoptional
Filter customers that have a membership with the given membership number
namestringoptional
Filter customers with a similar name to the given value
phonestringoptional
Filter customers with the given phone number
membershipstringoptional
Filter customers that have at least one membership of the given state. Set to "none" to filter customers that do not have any memberships, "any" to filter customers that have any memberships, and "needs_dd_mandate" for memberships awaiting a Direct Debit mandate or payment method.
membership_created_at_fromstringoptional
Filters customers which have at least one membership that was created on or after the given date
membership_created_at_tostringoptional
Filters customers which have at least one membership that was created on or before the given date
membership_type_idstringoptional
Filters customers which have at least one membership of the given membership type ID
membership_rate_idstringoptional
Filters customers which have at least one membership of the given membership rate ID
marketing_opt_instringoptional
Filters customers who are opted into the given marketing preference ID. Alternatively, pass "any" to filter customers opted into any marketing preference, or "none" to filter customers not opted into any preferences.
label_idsstring[]optional
Filters customers which have the given CustomerLabel ids.
created_at_fromstringoptional
Filters customers that were created on or after the given date.
created_at_tostringoptional
Filters customers that were created on or before the given date.
updated_at_fromstringoptional
Filters customers that were updated on or after the given date.
updated_at_tostringoptional
Filters customers that were updated on or before the given date.

Responses

200
The job was successfully queued
401
The user is unauthenticated

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

const response = await fetch('https://api.playground.try.be/customers/customers/queue', {
  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/customers/queue",
    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/customers/queue', [
    '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/customers/queue", 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 job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

get/customers/queued-jobs/{queuedJobId}

Get the details of a customer queued job

getCustomerQueuedJob

Returns the status and output of a customer-api background job that was previously kicked off via a queue-issuing endpoint (e.g. the customer list, check-ins, or memberships report queues). Poll this endpoint until status transitions to complete or failed; output then contains the per-job result envelope.

Only the user who enqueued the job can poll it.

Path parameters

queuedJobIdstringrequired
The ID of the queued job.

Responses

200
The job was successfully queued
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/queued-jobs/5ed2b4ea39e32a634f12521f" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/queued-jobs/5ed2b4ea39e32a634f12521f', {
  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/queued-jobs/5ed2b4ea39e32a634f12521f",
    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/queued-jobs/5ed2b4ea39e32a634f12521f', [
    '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/queued-jobs/5ed2b4ea39e32a634f12521f", 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 job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

put/customers/customers/{customerId}/barcodes/{barcodeId}/expiry-date

Update an Associated Barcode's expiry date

updateBarcodeExpiryDate

Changes when the given barcode stops being usable for identifying the customer at the till and at kiosks. Pass an ISO-8601 datetime in expires_at to set or extend the expiry, or null to clear it entirely (the barcode remains valid indefinitely).

The expires_at value must be in the future — barcodes cannot be back-dated through this endpoint. The change is audited against the customer record (updated_barcode) so the previous and new expiry are kept in the audit trail.

Use this instead of recreating the barcode when the underlying wearable / wristband stays the same but its lease term changes, e.g. when a member renews their pass or a day-spa wristband is handed back early.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
barcodeIduuidrequired
The unique identifier of the associated barcode this operation is scoped to.

Request body

expires_atdate-timerequirednullable
The ISO-8601 datetime at which the barcode should stop being accepted at kiosks, scanners and points-of-sale. Must be in the future relative to the request time. Pass null to remove any existing expiry.

Responses

200
The associated barcode was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/expiry-date" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "expires_at": "2026-12-31T23:59:59+00:00"
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/expiry-date', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "expires_at": "2026-12-31T23:59:59+00:00"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/expiry-date",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "expires_at": "2026-12-31T23:59:59+00:00"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/expiry-date', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'expires_at' => '2026-12-31T23:59:59+00:00'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"expires_at": "2026-12-31T23:59:59+00:00",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/expiry-date", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 associated barcode was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "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"
    },
    "barcode": "string",
    "expires_at": "2026-01-15T09:30:00+00:00",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "source": "kiosk",
    "order": {
      "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"
    },
    "payment_method": {
      "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"
    },
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}

put/customers/customers/{customerId}/barcodes/{barcodeId}/payment-method

Update an Associated Barcode's payment method

updateBarcodePaymentMethod

Links a PaymentMethod to the given barcode (or unlinks the current one). When a payment method is attached, charges captured via the barcode — typically wristband-based "post-pay" purchases at a spa or resort — are funded from that saved card rather than requiring the guest to present payment at every till.

Pass payment_method_id: null to detach the current payment method; subsequent tap-to-charge attempts on the barcode will then be declined or routed to a manual-pay flow depending on the site configuration.

The chosen PaymentMethod must belong to the same customer and pass server-side validation against the underlying processor (for card methods that means the card has to still be valid on the customer's processor profile). The change is recorded in the customer audit log under updated_barcode_payment_method.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
barcodeIduuidrequired
The unique identifier of the associated barcode this operation is scoped to.

Request body

payment_method_idstringrequirednullable
Identifier of a stored PaymentMethod belonging to the same customer, used as the default charge target when this barcode is presented at point-of-sale. For card methods the card must still be valid on the underlying processor profile. Pass null to detach the current method.

Responses

200
The associated barcode was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/payment-method" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "payment_method_id": "5e1e3f6c-2a44-4f6e-8c61-9c1f7d2e1c11"
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/payment-method', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "payment_method_id": "5e1e3f6c-2a44-4f6e-8c61-9c1f7d2e1c11"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/payment-method",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "payment_method_id": "5e1e3f6c-2a44-4f6e-8c61-9c1f7d2e1c11"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/payment-method', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'payment_method_id' => '5e1e3f6c-2a44-4f6e-8c61-9c1f7d2e1c11'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"payment_method_id": "5e1e3f6c-2a44-4f6e-8c61-9c1f7d2e1c11",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/barcodes/00000000-0000-0000-0000-000000000000/payment-method", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 associated barcode was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "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"
    },
    "barcode": "string",
    "expires_at": "2026-01-15T09:30:00+00:00",
    "brand_id": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "organisation_id": "00000000-0000-0000-0000-000000000000",
    "source": "kiosk",
    "order": {
      "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"
    },
    "payment_method": {
      "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"
    },
    "created_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

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

{
  "errors": {},
  "message": "The request didn't pass validation"
}