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 ID of the customer.
first_nameThe first name of the customer.
last_nameThe last name of the customer.
full_nameThe customer's full name
phoneThe customer's phone number in E.164 format, or null if not provided.
Whether the user has a password
dobThe customer's date of birth in YYYY-MM-DD format, or null if not provided.
The ID of the brand this customer belongs to
The ID of the site this customer belongs to
stripe_idThe Stripe Customer ID for this customer
express_stripe_idThe Stripe Customer ID for this customer if they also exist in Trybe's legacy Stripe integration
emailThe email address of the customer.
The case of the email address is not preserved, so you'll always see this in lowercase.
An array of labels associated with this customer
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_atThe datetime which the customer was locked, or null if it has not been locked.
The datetime which the customer was created
The datetime which the customer was last updated
deleted_atThe datetime which the customer was anonymised, or null if it has not been.
last_active_atThe datetime which the customer was last active
email_verified_atThe datetime which the customer verified their email address
last_check_inA summary of the last check-in event associated with this customer, or null if they have never checked-in.
avatar_idThe media ID of the customer's avatar, or null if one hasn't been provided.
avatarThe media object of the customer's avatar, or null if one hasn't been provided.
external_refAn external reference for this customer.
""actionCustomerSearchUse this endpoint to search for customers.
site_idFilter results by the site they belong to
queryA general search query to match against customer fields.
sourceChoose which sources to include in the search.
first_nameFilter by first name.
last_nameFilter by last name.
emailFilter by email address.
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"sources": [
"trybe",
"trybe",
"trybe",
"trybe"
],
"labels": [
{
"id": "d533e5a0-19b1-7ade-253f-4be42e9bc5dd",
"name": "VIP",
"color": "#FF5733"
}
]
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"sources": [
"trybe"
],
"labels": [
{
"id": "e28195c7-0955-5742-b3a4-ca09061d5650",
"name": "VIP",
"color": "#FF5733"
},
{
"id": "eb3b7cd5-5f07-6467-574f-51ce8436e1f3",
"name": "VIP",
"color": "#FF5733"
}
]
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"sources": [
"trybe"
],
"labels": [
{
"id": "9c3a8506-c5a9-b64d-1ac0-5cb2c0382e88",
"name": "VIP",
"color": "#FF5733"
},
{
"id": "7bc7f6a7-999e-f1e1-4d9f-f101e7b570a0",
"name": "VIP",
"color": "#FF5733"
},
{
"id": "4edf3e64-b046-2df6-7d88-4b34838a5f7e",
"name": "VIP",
"color": "#FF5733"
}
]
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"sources": [
"trybe",
"trybe",
"trybe"
],
"labels": [
{
"id": "81a63428-cb63-192d-ce48-a2513722215d",
"name": "VIP",
"color": "#FF5733"
},
{
"id": "945f59e5-f740-f0b1-b8cb-176bf54f1bc0",
"name": "VIP",
"color": "#FF5733"
}
]
}
],
"meta": {
"sources": [
{
"key": "trybe",
"name": "Trybe",
"status": "success",
"message": "Trybe did not respond in time."
},
{
"key": "trybe",
"name": "Trybe",
"status": "success",
"message": "Trybe did not respond in time."
}
]
}
}{
"message": "The request didn't pass validation",
"errors": [
{
"laboris33": "cupidatat ea"
}
]
}getCustomerStatsUse this endpoint to retrieve high-level stats for a single customer.
customerIdThe ID of the customer being accessed.
{
"data": {
"totals": {
"total_order_value": 38500,
"average_order_value": 19250,
"num_orders": 2
},
"recent_orders": [
{
"id": "6900d1d9faeab4011e000031",
"order_ref": "ad",
"status": "cancelled",
"num_items": 2,
"customer": {
"id": "2472e600-8238-ec41-d70a-2f518b2c5f98",
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Jones"
},
"sales_channel": {
"id": "6900d1d9faeab4011e000032"
},
"totals": {
"order_discount": 0,
"total": 15000
},
"submitted_at": "1900-03-16T22:44:19.0Z",
"site": {
"id": "ed4792f1-73e1-9941-91b2-de0485507fe1",
"name": "Palm Tree Spa"
}
},
{
"id": "6900d1d9faeab4011e000033",
"order_ref": "ullamco veniam do deserunt",
"status": "cancelled",
"customer": {
"id": "b326ef8b-812f-fbd1-399e-d4fb6509f200",
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Jones"
},
"sales_channel": {
"id": "6900d1d9faeab4011e000034",
"name": "Website"
},
"totals": {
"subtotal": 15000,
"order_discount": 0
},
"submitted_at": "1899-04-28T23:56:28.0Z",
"site": {
"id": "402b76a7-598d-9213-06b8-68ed8293b70a",
"name": "Palm Tree Spa"
}
},
{
"id": "6900d1d9faeab4011e000035",
"order_ref": "Lorem quis",
"status": "submitted",
"customer": {
"id": "9ba6692a-b262-63d5-b7be-add55eed0990",
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Jones"
},
"sales_channel": {},
"totals": {
"total": 15000
},
"submitted_at": "1953-05-11T03:35:39.0Z",
"site": {
"id": "571011d0-e99c-7fe1-44a4-1480327d5f97",
"name": "Palm Tree Spa"
}
},
{
"id": "6900d1d9faeab4011e000036",
"order_ref": "et",
"status": "submitted",
"num_items": 2,
"customer": {
"id": "e0b654de-7f30-9cd9-2c0e-a703d11a4969",
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Jones"
},
"sales_channel": {
"id": "6900d1d9faeab4011e000037",
"name": "Website"
},
"totals": {
"subtotal": 15000,
"order_discount": 0,
"total": 15000
},
"submitted_at": "1913-04-25T21:50:50.0Z",
"site": {
"id": "12689500-7e39-b748-9c98-1d31a3b13578",
"name": "Palm Tree Spa"
}
}
]
},
"meta": {
"currency": "gbp"
}
}{
"message": "The requested resource could not be found"
}listCustomersThis endpoint lists the Customers which are associated to the provided site.
Filters customers with a similar name, email or phone number to the given value
Filter customers with the given email address
Filter customers that belong to the given organisation ID
Filter customers that belong to the given brand ID
Filter customers that belong to the given site ID
Filter customers that have a membership with the given membership number
Filter customers with a similar name to the given value
Filter customers with the given phone number
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.
Filters customers which have at least one membership that was created on or after the given date
Filters customers which have at least one membership that was created on or before the given date
Filters customers which have at least one membership of the given membership type ID
Filters customers which have at least one membership of the given membership rate ID
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.
Filters customers which have the given CustomerLabel ids.
Filters to just the customers with the given IDs.
pageThe page to retrieve results from
per_pageThe number of results to return per page
The Customers were successfully retrieved
{
"data": [
{
"id": "09bdf21d-ef03-acb7-9442-af0784e49e71",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1939-07-24",
"brand_id": "8ad823eb-4973-73fa-6c87-02e009ff76b9",
"site_id": "86c4a0fb-e736-9744-e47b-0eb2573fa830",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "b3ffb88c-ef55-20c2-83a5-ab08d8f45385",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1916-02-20T13:38:50.0Z",
"created_at": "1904-07-26T05:05:10.0Z",
"updated_at": "1917-10-18T18:01:51.0Z",
"deleted_at": "1940-02-26T06:29:29.0Z",
"last_active_at": "1969-12-16T10:18:53.0Z",
"email_verified_at": "1898-06-08T23:09:36.0Z",
"last_check_in": {
"checked_in_at": "1954-06-09T17:40:04.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "64a124b2-7562-d0a6-cb14-b92b843b608e",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "sed aute"
}
],
"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"
}
}createCustomerUse this endpoint to create a new Customer.
When creating a new Customer, you must specify at least one of the following fields along with any other fields marked as required:
emailfirst_namelast_namesite_idThe ID of the site this customer belongs to
first_nameThe first name of the customer.
last_nameThe last name of the customer.
phoneThe customer's phone number in E.164 format, or null if not provided.
dobThe customer's date of birth in YYYY-MM-DD format, or null if not provided.
emailThe email address of the customer.
The case of the email address is not preserved, so you'll always see this in lowercase.
The customer's password. This must be at least 8 characters long
An array of marketing preference IDs to opt the customer in to
external_refAn external reference for this customer.
The guestline reference for this customer.
The preferred locale of the customer.
This must be one of the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.
The Customer was successfully retrieved
{
"data": {
"id": "9d4209b1-5fc1-fe08-bfdf-64863e7bbd7a",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1957-04-24",
"brand_id": "525418ce-5593-e92d-e5ba-b8b2b551c425",
"site_id": "82ae1c78-3a38-7e2e-bde8-8330e771232a",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "cba3e81f-c336-550d-c1a6-988458a2eab1",
"name": "VIP",
"color": "ff6634"
},
{
"id": "1b0ac16a-035e-3fcf-cc94-b00bd2c4dc35",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1920-12-26T02:11:21.0Z",
"created_at": "1950-03-01T22:09:01.0Z",
"updated_at": "1950-02-25T05:54:51.0Z",
"deleted_at": "1892-10-23T21:40:36.0Z",
"last_active_at": "1940-07-16T10:03:29.0Z",
"email_verified_at": "1916-11-03T01:05:01.0Z",
"last_check_in": {
"checked_in_at": "1952-04-19T01:06:54.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "14520104-e598-8bc2-ffc7-141335cbdc46",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "commodo in"
}
}getCustomerUse this endpoint to retrieve a Customer by their ID.
customerIdThe ID of the customer
{
"data": {
"id": "09e2c9e5-408d-6de2-af5d-04520d45981b",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1949-12-02",
"brand_id": "a28a7f85-614f-c528-f91e-15971b120dcb",
"site_id": "ef751498-9c8c-70fb-2fb6-c73cc007c1d6",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "1b601674-8966-47aa-ba7f-06a926e66f42",
"name": "VIP",
"color": "ff6634"
},
{
"id": "710de7fc-ad2f-4e46-0786-4f55ff14f68a",
"name": "VIP",
"color": "ff6634"
},
{
"id": "700dbb81-ba7d-77ca-338d-08128486e535",
"name": "VIP",
"color": "ff6634"
},
{
"id": "bfc7bae0-7088-03d8-8e4e-9a9d1feb271c",
"name": "VIP",
"color": "ff6634"
},
{
"id": "a6fa371a-e634-76e3-ece5-ea000fdfaeea",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1914-06-19T03:07:22.0Z",
"created_at": "1942-12-06T18:20:50.0Z",
"updated_at": "1932-01-08T17:59:05.0Z",
"deleted_at": "1897-05-29T16:21:26.0Z",
"last_active_at": "1934-06-23T03:36:15.0Z",
"email_verified_at": "1931-03-14T07:12:20.0Z",
"last_check_in": {
"checked_in_at": "1965-12-24T23:19:49.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "b02d50e9-d154-5d9e-f7a4-65d12f3c8fc4",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "aliqua veniam voluptate adipisicing"
}
}{
"message": "The requested resource could not be found"
}updateCustomerUse this endpoint to update an existing Customer.
customerIdThe ID of the customer
first_nameThe first name of the customer.
last_nameThe last name of the customer.
phoneThe customer's phone number in E.164 format, or null if not provided.
dobThe customer's date of birth in YYYY-MM-DD format, or null if not provided.
The customer's password. This must be at least 8 characters long
external_refAn external reference for this customer.
The preferred locale of the customer.
This must be one of the platform's supported locales, which can be retrieved using the listMetaSupportedLocales endpoint.
{
"data": {
"id": "633e1de0-b630-f225-6db1-bb3d25206238",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1923-04-10",
"brand_id": "d37fef36-8613-651a-07fb-f178be593f64",
"site_id": "59da8b52-7f38-a7a9-3b63-8c6ee195e662",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "12ba0357-6485-3116-e6e7-c441ad4bdc35",
"name": "VIP",
"color": "ff6634"
},
{
"id": "aa5413d1-c068-f321-5f84-de5059609b0c",
"name": "VIP",
"color": "ff6634"
},
{
"id": "7d4dd59d-26d2-0b63-9969-8ea84961a55a",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1910-11-23T13:48:35.0Z",
"created_at": "1961-02-13T21:34:13.0Z",
"updated_at": "1933-05-31T23:39:10.0Z",
"deleted_at": "1968-04-04T04:37:47.0Z",
"last_active_at": "1932-03-07T16:11:45.0Z",
"email_verified_at": "1952-10-19T03:32:36.0Z",
"last_check_in": {
"checked_in_at": "1926-01-08T09:06:59.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "3b00d9ff-513b-a506-a909-f888dd513f9d",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "irure proident"
}
}{
"message": "The requested resource could not be found"
}listAssociatedBarcodesThis endpoint retrieves all barcodes associated with a customer.
customerIdThe ID of the customer
The barcodes associated with the customer were successfully retrieved
{
"data": [
{
"id": "58891046-0018-f631-4d26-cd06cb0b650b",
"customer_id": "6213eedd-4c19-5bea-5e8a-6e37d1608a5d",
"barcode": "velit esse laboris",
"expires_at": "1962-03-30T01:57:48.0Z",
"brand_id": "3c72645e-0fdf-cce9-df60-4cc58d011a95",
"site_id": "0d1e93cf-d517-6397-573e-4210b2a5e7f4",
"organisation_id": "73176cce-7a32-46d4-037c-7aa208c5d578",
"source": "kiosk",
"order_id": "31153fde-bec7-bdac-20e8-89cef3bde001",
"payment_method": {
"id": "f8ed36e1-5411-7353-95c1-63030cc3947b",
"payment_method_id": "pm_3K6a0RGysTOePye00nkob5Pi",
"name": "My debit card",
"type": "direct_debit",
"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-01T01:01:01.0Z",
"updated_at": "2025-01-01T01:01:01.0Z",
"revoked_at": "2025-01-01T01:01:01.0Z"
},
"created_at": "1940-04-05T15:19:44.0Z"
}
]
}updateWearableExpiryDateThis endpoint updates the expiry date for a wearable device associated with a customer.
customerIdThe ID of the customer
barcodeIdThe ID of the barcode
The expiry date for the wearable device.
The payment method for the wearable device was successfully retrieved
{
"data": {
"source": "kiosk",
"payment_method": {
"id": "9c7e388e-9fe1-8a35-f4fc-acc946a668a3",
"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-01T01:01:01.0Z",
"updated_at": "2025-01-01T01:01:01.0Z",
"revoked_at": "2025-01-01T01:01:01.0Z"
},
"created_at": "1929-02-22T22:08:46.0Z"
}
}updateWearablePaymentMethodThis endpoint updates the payment method assigned to a wearable device for a customer.
customerIdThe ID of the customer
barcodeIdThe ID of the barcode
payment_method_idThe ID of the payment method to associate with the wearable device.
The payment method for the wearable device was successfully retrieved
{
"data": {
"id": "8997788a-8cfd-f2fd-5b11-2971bf42822e",
"customer_id": "c52cf8c9-1b1f-466e-3f81-0cdf649edfb6",
"barcode": "non voluptate proident nisi ullamco",
"expires_at": "1945-01-28T19:43:26.0Z",
"brand_id": "787ff587-6955-b540-33cd-35d81029f2ce",
"site_id": "095f9693-e2cf-8b7a-473f-cd637202936c",
"organisation_id": "f47a531d-78b4-6519-294b-7b48cd9fdd6d",
"source": "kiosk",
"order_id": "0ff696e5-8ae3-6120-aefc-a272c707bae8",
"payment_method": {
"id": "e8959a50-61a1-2fb5-1e79-2f4c7ed9b814",
"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-01T01:01:01.0Z",
"updated_at": "2025-01-01T01:01:01.0Z",
"revoked_at": "2025-01-01T01:01:01.0Z"
},
"created_at": "1902-10-14T12:51:59.0Z"
}
}getCustomerMembershipsUse 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.
customerIdThe ID of the customer
{
"data": [
{
"id": "36ac01ea-30e3-fd36-2065-70b9975ef56d",
"membership_number": "1234567890",
"customer": {
"id": "4b88f996-bba5-0651-aa17-78544b96afab",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1936-07-14",
"brand_id": "35d153f8-f2d9-1c4a-2c91-ed389bd07f96",
"site_id": "46fbb0c3-d76a-75e0-12b9-a69d762e6f8f",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "df3bad59-68a0-b3e3-7a76-faff40d014cb",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1947-09-17T14:10:05.0Z",
"created_at": "1899-02-25T11:56:02.0Z",
"updated_at": "1905-02-09T13:10:06.0Z",
"deleted_at": "1936-09-01T04:06:03.0Z",
"last_active_at": "1967-06-14T12:22:35.0Z",
"email_verified_at": "1924-04-30T20:54:19.0Z",
"last_check_in": {
"checked_in_at": "1936-12-10T12:42:06.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "14d0d3cd-a748-6b60-ed97-d22ef93f68f3",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "Ut pariatur"
},
"members": [
{
"customer_id": "42f86494-0371-234f-1421-71ede2b7a702",
"membership_number": "1234567890",
"is_lead": false
}
],
"type": {
"id": "0a7df764-1c99-2116-f203-e303a069d81b",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "esse tempor adipisicing quis",
"brand_id": "1ea41b8e-7ad8-b25f-84d5-52df79a0284c",
"offline_payments": false,
"disable_confirmation_email": false,
"private": false,
"visibility": "public",
"minimum_start_date": "1930-12-21T22:38:04.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1914-06-24T04:39:45.0Z",
"updated_at": "1964-10-02T03:38:46.0Z",
"deleted_at": "1899-06-05T23:34:12.0Z"
},
"status": "reserved",
"source": "app",
"start_date": "1895-11-02T09:25:38.0Z",
"end_date": "1943-12-25T22:37:55.0Z",
"next_charge": {
"id": "33cae603-d6bf-f29b-c0f0-2d14c854fa94",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1932-10-17",
"billing_period_to": "1968-12-25"
},
"attention_reason": "no_mandate"
},
{
"id": "1216944f-7c1f-cddf-802a-c277fa385da3",
"site_id": "c6802af4-57ba-b710-f122-65648da571bd",
"membership_number": "1234567890",
"customer": {
"id": "9f3f47cc-97f8-3ef1-dc5a-4e6f60b9242c",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1909-05-12",
"brand_id": "d02dce10-9d22-379d-5bbd-53bf8610c74e",
"site_id": "c315aeea-a985-352a-563b-46e8cdfcc61c",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "a6bfc03e-b9bd-e69a-54be-959ee19aab38",
"name": "VIP",
"color": "ff6634"
},
{
"id": "b9c0529a-f954-76f8-b32b-09e71f211947",
"name": "VIP",
"color": "ff6634"
},
{
"id": "16f0601e-25cd-bed3-1ee6-ab5ee8dd43fc",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1904-09-30T07:32:16.0Z",
"created_at": "1902-05-27T17:49:40.0Z",
"updated_at": "1899-06-18T21:14:59.0Z",
"deleted_at": "1903-02-11T03:03:26.0Z",
"last_active_at": "1908-07-28T18:29:13.0Z",
"email_verified_at": "1953-09-21T21:14:23.0Z",
"last_check_in": {
"checked_in_at": "1959-02-01T20:28:34.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "982ad5cd-2278-1ae6-211b-059b270732ca",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "Lorem et"
},
"members": [
{
"customer_id": "caa81af8-3aca-c194-16dc-3cc8bceeec3e",
"membership_number": "1234567890",
"is_lead": true
},
{
"customer_id": "add7158c-6a05-e59d-3ff6-164fa79bb380",
"membership_number": "1234567890",
"is_lead": true
},
{
"membership_number": "1234567890"
},
{
"customer_id": "330420bb-aa2f-4030-a255-39c7d4423523",
"membership_number": "1234567890"
},
{
"customer_id": "4094fb32-82ea-cc44-a397-8f0292d2b243",
"membership_number": "1234567890"
}
],
"type": {
"id": "0fc18e45-0a4c-2eda-142f-63a3602e861b",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "ipsum",
"brand_id": "2e182ab3-8ea1-43bb-77df-aed3222fa39e",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "private",
"minimum_start_date": "1949-08-20T06:16:55.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1902-12-15T09:17:15.0Z",
"updated_at": "1905-10-15T10:23:05.0Z",
"deleted_at": "1901-02-16T23:04:13.0Z"
},
"rate": {
"id": "7f0b3ffa-79ae-4b95-d7ee-b87d080111bf",
"membership_type_id": "9f61ce4c-2d99-5399-d911-3a2973afa483",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"tempor incididunt id sed nostrud",
"consequat deserunt nisi laborum anim",
"occaecat cillum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1951-01-29T16:07:59.0Z",
"updated_at": "1925-09-05T04:41:23.0Z"
},
"status": "expired",
"source": "import",
"payment_method": {
"id": "minim nulla fugiat",
"type": "card",
"status": "revoked"
},
"start_date": "1931-05-05T10:59:59.0Z",
"end_date": "1913-10-06T04:03:49.0Z",
"created_at": "1916-06-20T06:16:45.0Z"
},
{
"id": "83fd2f5e-a85b-befa-8906-4ccc31900506",
"site_id": "72e508f2-d1d2-22f4-c6ae-ece7dcec6499",
"membership_number": "1234567890",
"customer": {
"id": "6a22d721-3a4e-412c-7dcd-3b8b58b3c2a1",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1951-09-12",
"brand_id": "8eb94ea5-4b4d-c7e1-317c-44fe416d438d",
"site_id": "7c001a03-30db-cb74-e810-8f52d5a21366",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "c5f7cce3-fd31-2ba1-3a46-8b8acbe8107e",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1948-07-05T18:04:24.0Z",
"created_at": "1915-09-17T20:08:26.0Z",
"updated_at": "1921-07-05T04:18:36.0Z",
"deleted_at": "1948-05-10T12:18:54.0Z",
"last_active_at": "1923-05-26T20:05:59.0Z",
"email_verified_at": "1958-05-29T15:41:42.0Z",
"last_check_in": {
"checked_in_at": "1893-01-15T19:18:07.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "d69b68ad-39a7-8a47-8cd3-760fcff5911a",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "ad consequat cupidatat dolore sed"
},
"members": [
{
"customer_id": "87574dee-7550-34c8-e793-957638f3a2e3",
"is_lead": false
},
{
"customer_id": "cc6ba158-7b9f-62c2-e589-edea592547d3",
"membership_number": "1234567890",
"is_lead": true
}
],
"type": {
"id": "dfbd6b51-d868-db25-be2c-60a9fa625053",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "fugiat",
"brand_id": "613dc0f1-76d0-db6a-5dd5-6a1bcc364b90",
"offline_payments": true,
"disable_confirmation_email": true,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1942-05-05T01:11:06.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "578e7e2a-8b46-e29e-9d65-484980319846"
},
{
"id": "d5ad18c3-8d9e-0e9d-9720-25a23876d6cb",
"membership_type_id": "3917883b-d841-a4cc-eb8e-8107840d46d9",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"id exercitation ea labore",
"amet magna veniam",
"minim dolor Ut",
"sunt",
"sit incididunt est dolore"
],
"default_duration": "P1Y",
"private": true
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1917-12-12T18:26:43.0Z",
"updated_at": "1949-06-09T08:47:44.0Z",
"deleted_at": "1943-04-09T18:18:28.0Z"
},
"rate": {
"id": "2ce3d7e8-fe11-7a1c-5b78-2e8b642f2f0f",
"membership_type_id": "f5bdde18-7108-20f3-0117-31c55758a83d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000
},
"status": "upcoming",
"source": "app",
"payment_method": {
"id": "deserunt Duis",
"type": "card",
"last_4": "mollit dolore nulla in laborum",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1904-06-20T10:27:59.0Z",
"end_date": "1919-04-28T03:43:27.0Z",
"created_at": "1903-03-26T22:45:28.0Z",
"basket_id": "6900d1d9faeab4011e000038",
"external_ref": "et deserunt quis ut",
"next_billing_date": "1944-09-24T22:10:29.0Z",
"next_charge": {
"id": "a032e283-4137-c43f-cdfb-4d923d59e0c7",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1952-10-30",
"billing_period_to": "1940-11-22"
},
"attention_reason": "payment_outstanding"
},
{
"id": "abcdf750-5846-24f4-b635-eea5a3eca0c1",
"site_id": "115f1d5d-8853-db5e-4556-143ddfb7276e",
"membership_number": "1234567890",
"customer": {
"id": "aaaceb73-5057-8023-5450-5abccbfc8bd9",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1922-08-22",
"brand_id": "048f5dea-d6b0-8412-2fac-0961af57908b",
"site_id": "4205b5e4-b92f-7589-486c-e6b2eacde6af",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "53f6c623-454e-fbdd-4826-2e0d827634d4",
"name": "VIP",
"color": "ff6634"
},
{
"id": "1d147268-ef26-de4f-e9f5-b29b1007d441",
"name": "VIP",
"color": "ff6634"
},
{
"id": "f359a474-db83-361c-2439-9b4176ed5560",
"name": "VIP",
"color": "ff6634"
},
{
"id": "cd49d517-8b3c-b86f-8d5d-40974681fd1a",
"name": "VIP",
"color": "ff6634"
},
{
"id": "b1915ea5-092d-106e-7218-03f15fd68fe3",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1964-11-12T11:35:40.0Z",
"created_at": "1930-11-25T16:41:27.0Z",
"updated_at": "1948-05-14T16:04:24.0Z",
"deleted_at": "1944-05-27T23:46:06.0Z",
"last_active_at": "1899-05-19T23:02:45.0Z",
"email_verified_at": "1966-01-09T02:50:29.0Z",
"last_check_in": {
"checked_in_at": "1897-12-28T13:49:41.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "be7bdeb0-f4ef-f6af-6865-e3bcf31d4b8c",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "id aliqua nulla"
},
"members": [
{
"customer_id": "500149e4-9331-9fc7-4a75-1e1a8167a49a",
"membership_number": "1234567890"
},
{
"customer_id": "18f97713-17dc-539e-56e9-e14c99aa32ea",
"membership_number": "1234567890",
"is_lead": true
},
{
"customer_id": "bb10d66b-82dc-5ee5-4df0-10cb19657aac",
"membership_number": "1234567890",
"is_lead": true
},
{
"is_lead": false
},
{
"customer_id": "b04bd141-b45b-0cf3-f5fb-9b25740426de",
"membership_number": "1234567890",
"is_lead": false
}
],
"type": {
"id": "a99e07f1-7823-2b42-530c-e8b4f3372e85",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "qui dolor",
"brand_id": "363eba34-d5d7-5bd0-e9a1-484318514bbc",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1969-05-04T08:47:26.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "c5de4aed-1082-24c6-9a7d-07f6dbe8a49b",
"membership_type_id": "89305d3e-2e64-1460-0d8a-abb008770538",
"name": "Standard rate",
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"consequat ipsum id sunt aliqua"
],
"created_at": "1969-11-15T07:03:35.0Z",
"updated_at": "1952-04-27T16:31:53.0Z"
},
{
"membership_type_id": "0282ea60-7b27-e03e-785a-afd85373bc88",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"ex non cupidatat",
"qui ut occaecat velit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-11-18T19:48:38.0Z"
},
{
"id": "8bd1b05d-67f5-1613-2e7b-89622d3f1720",
"name": "Standard rate",
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"created_at": "1933-04-15T15:14:23.0Z"
},
{
"id": "70ec8105-6d55-21fb-636e-6c82ef1d0eb2",
"membership_type_id": "4ce073a4-ffa2-7d14-5af7-2424c03a78a9",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"laboris Lorem et consectetur",
"aliqua do adipisicing",
"est in nostrud quis",
"aliquip sunt sint ullamco esse"
],
"default_duration": "P1Y"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1959-08-27T12:38:03.0Z",
"updated_at": "1929-07-22T23:54:34.0Z",
"deleted_at": "1935-10-27T20:52:34.0Z"
},
"rate": {
"id": "74794bba-8428-4691-4d41-14978e4a0591",
"membership_type_id": "e2253755-2084-0b8c-f585-b40d96d63b29",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"created_at": "1907-10-11T11:49:19.0Z"
},
"status": "expired",
"source": "app",
"payment_method": {
"id": "enim sint est nostrud irure",
"type": "card",
"last_4": "dolor aliqua dolore culpa occaecat",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1929-02-14T18:04:23.0Z",
"end_date": "1934-04-29T23:55:10.0Z",
"created_at": "1955-04-17T06:20:56.0Z",
"basket_id": "6900d1d9faeab4011e000039",
"external_ref": "dolor est",
"next_billing_date": "1898-03-22T14:23:11.0Z",
"next_charge": {
"id": "0d094add-d8a3-8bb3-8d92-cbc5ebdebc53",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1897-10-01",
"billing_period_to": "1944-04-10"
},
"attention_reason": "payment_disputed"
}
],
"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": "The requested resource could not be found"
}actionLockCustomerUse 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.
customerIdThe ID of the customer
{
"data": {
"id": "afe6b5a6-04a7-2714-68ce-7ae05c7fc477",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1898-07-22",
"brand_id": "0a42257f-f3a9-1ff4-1a27-f8784ddeccd9",
"site_id": "3338e4c7-e895-ec17-a8ce-0e34728c1a27",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "41a02eae-7a42-1be3-76ab-86d07177b42b",
"name": "VIP",
"color": "ff6634"
},
{
"id": "b5c1235e-2459-5d8a-7ed5-2696dea12682",
"name": "VIP",
"color": "ff6634"
},
{
"id": "e4e74308-87fb-25a2-f26c-e76c0b8b71f3",
"name": "VIP",
"color": "ff6634"
},
{
"id": "50040d68-7af4-77b0-c23a-6d0850c1e258",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1902-07-13T05:38:23.0Z",
"created_at": "1957-02-03T08:01:08.0Z",
"updated_at": "1929-02-07T09:17:52.0Z",
"deleted_at": "1945-07-14T04:50:39.0Z",
"last_active_at": "1921-01-31T06:15:06.0Z",
"email_verified_at": "1937-05-03T11:52:15.0Z",
"last_check_in": {
"checked_in_at": "1941-08-11T23:55:33.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "582a8cb1-9586-7dee-9a31-ecff851135f6",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "fugiat nisi ut est"
}
}{
"message": "The requested resource could not be found"
}actionUnlockCustomerUse this endpoint to unlock a Customer.
customerIdThe ID of the customer
{
"data": {
"id": "7943f55a-64f9-e478-d02e-dae6c606d78f",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1897-06-02",
"brand_id": "76f6aa14-1070-e79b-6bff-0e41995a3100",
"site_id": "8637cee6-c22b-576d-5445-e0ce2f8bb9b5",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "b4531889-075a-b972-4af9-10f5daf287a8",
"name": "VIP",
"color": "ff6634"
},
{
"id": "733d2590-9af9-ea2f-d313-c2de427da9cc",
"name": "VIP",
"color": "ff6634"
},
{
"id": "ceacdb35-6a16-dc97-95b4-94ef743ce3c1",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1930-02-06T22:10:36.0Z",
"created_at": "1910-03-23T04:05:41.0Z",
"updated_at": "1892-04-02T08:22:56.0Z",
"deleted_at": "1891-04-14T23:27:43.0Z",
"last_active_at": "1919-12-19T14:27:46.0Z",
"email_verified_at": "1952-02-28T17:38:39.0Z",
"last_check_in": {
"checked_in_at": "1945-03-11T04:23:39.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "500fe265-17f6-8da7-0e79-119bf86cc1f4",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "laborum do tempor irure nisi"
}
}{
"message": "The requested resource could not be found"
}actionTriggerCustomerPasswordResetUse 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.
customerIdThe ID of the customer
{
"data": {
"id": "8ac1a39c-0f09-6b4e-0a17-198a0831c2aa",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1911-05-31",
"brand_id": "ed9d4004-3653-b3f1-acc9-858adfc4858d",
"site_id": "d8d51048-0d1e-33bc-a438-87f6aea5229c",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1896-09-24T11:22:28.0Z",
"created_at": "1947-03-17T20:48:46.0Z",
"updated_at": "1926-09-29T08:13:19.0Z",
"deleted_at": "1905-01-27T22:34:12.0Z",
"last_active_at": "1931-01-06T02:33:07.0Z",
"email_verified_at": "1943-07-24T11:46:26.0Z",
"last_check_in": {
"checked_in_at": "1917-07-16T06:15:45.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "858becd6-4117-a36c-e16b-55a51ac8637f",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "occaecat"
}
}{
"message": "The requested resource could not be found"
}actionResendCustomerVerificationUse 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.
customerIdThe ID of the customer
{
"data": {
"id": "1680b157-8cf7-d81b-2ad1-efe4cce892bd",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1907-09-22",
"brand_id": "812dd9aa-8221-6f65-89fd-34e7eafb3264",
"site_id": "3f612f5b-3825-80b8-a17f-6e5c5cc1f307",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1911-07-05T04:59:05.0Z",
"created_at": "1900-08-24T20:58:26.0Z",
"updated_at": "1910-12-23T15:53:25.0Z",
"deleted_at": "1945-08-30T12:01:47.0Z",
"last_active_at": "1893-05-07T01:53:35.0Z",
"email_verified_at": "1917-01-17T12:47:10.0Z",
"last_check_in": {
"checked_in_at": "1941-06-30T12:20:53.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "0e63755d-47da-709a-374e-3be806fd00ec",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "exercitation Ut Lorem pariatur"
}
}{
"message": "The requested resource could not be found"
}