A Membership represents a membership belonging to one or more Customers.
The ID of the membership
The ID of the site this membership belongs to
membership_numberThe unique membership number of the lead member. This is always a 10 digit numeric string.
Since this field only relates to the lead member, this is now deprecated.
Instead, find the membership for the relevant customer in the members array.
Possible values are active, needs_dd_mandate, needs_attention, reserved, inactive, expired and upcoming
Where the membership was created
Possible values are self_signup, app, import and unknown
Details about the payment method attached to this membership. This payment method is used to take payment on the monthly billing period. If a payment method hasn't been set up, this will be null.
The date which the membership starts
The date which the membership ends
The datetime which the membership was created
The basket ID which was used to purchase this membership, if applicable.
An external reference for this membership.
The date which the membership will next be billed
next_chargeA summary of the next charge that's due for this membership.
This property is only populated when the membership was retrieved using the `getCustomerMemberships endpoint.
A string describing what kind of action needs to take place
Possible values are no_mandate, setup_unpaid, mandate_revoked, payment_failed, payment_disputed, payment_outstanding and site_id
""listMembershipsThis endpoint lists the Memberships which are associated to the provided site.
The Memberships were successfully retrieved
{
"data": [
{
"id": "f02e5bff-b2c9-094e-61eb-87305b362b91",
"site_id": "d14f942d-4d52-fd39-95a7-c42c536c43c6",
"membership_number": "1234567890",
"customer": {
"id": "915f3559-4dfb-499f-377b-438f5f352855",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1954-03-20",
"brand_id": "d4431df4-722e-fd65-c2e3-dd197da50d7b",
"site_id": "2ac57087-8635-7ac9-dff6-b652f59df419",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1896-08-27T16:29:21.0Z",
"created_at": "1910-06-02T23:36:35.0Z",
"updated_at": "1914-05-21T03:15:01.0Z",
"deleted_at": "1893-12-08T09:19:34.0Z",
"last_active_at": "1898-12-03T18:34:03.0Z",
"email_verified_at": "1901-08-02T23:28:42.0Z",
"last_check_in": {
"checked_in_at": "1929-01-12T23:10:16.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "ded7836f-7fe5-b6a7-76f3-28f5fb7573a3",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "reprehenderit enim velit"
},
"members": [
{
"customer_id": "1d0a984a-f414-6e80-d703-ddbc41bc7a97",
"membership_number": "1234567890",
"is_lead": true
},
{
"customer_id": "00a7e743-741a-fee2-9510-2f8cc6d97b24",
"membership_number": "1234567890",
"is_lead": true
},
{
"membership_number": "1234567890",
"is_lead": false
},
{
"customer_id": "64eebdec-04fe-5cc6-0f42-863cb7d7e554",
"membership_number": "1234567890"
}
],
"type": {
"id": "a31bec92-2100-3d53-c529-2217c0dfc3b0",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "officia dolor",
"brand_id": "6f0c71c2-2684-ca6d-8206-c9bdb6541caa",
"offline_payments": false,
"disable_confirmation_email": true,
"private": false,
"visibility": "private",
"minimum_start_date": "1958-12-23T06:59:49.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"membership_type_id": "303466e9-7748-835c-e1c1-f9953cd7365c",
"name": "Standard rate",
"price": 5000,
"default_duration": "P1Y"
},
{
"id": "750f2148-ac18-61c8-a3c1-dcb987231476",
"membership_type_id": "5e833b41-0329-a778-8dec-456020fea228",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"anim dolor",
"Lorem ea in irure sunt",
"consectetur dolor",
"quis amet Ut mollit tempor",
"aute aliqua"
],
"default_duration": "P1Y",
"private": true,
"updated_at": "1942-08-24T02:39:59.0Z"
},
{
"id": "cb8f8a02-5a2a-0366-b7b1-822a2d017dfd"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1913-06-06T11:20:23.0Z",
"updated_at": "1917-12-13T16:26:08.0Z",
"deleted_at": "1908-03-31T13:04:01.0Z"
},
"rate": {
"id": "0259893b-0dbf-6baf-d30f-41dfa83e601c",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1922-02-19T09:18:28.0Z",
"updated_at": "1946-11-17T07:27:29.0Z"
},
"status": "upcoming",
"source": "import",
"payment_method": {
"id": "occaecat cupidatat",
"type": "card",
"last_4": "minim in ullamco laborum aliqua",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1936-01-23T14:09:33.0Z",
"end_date": "1931-07-25T11:21:06.0Z",
"created_at": "1904-01-03T07:52:31.0Z",
"basket_id": "68ff59616decbc01250000c8",
"external_ref": "id eiusmod",
"next_billing_date": "1946-05-28T08:04:31.0Z",
"next_charge": {
"id": "58676ed4-28d7-7e89-865b-b2bd6a7d8fc3",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1941-04-16",
"billing_period_to": "1909-12-21"
},
"attention_reason": "setup_unpaid"
},
{
"id": "e6f7b714-0cc4-8053-e73d-a8ad912e215a",
"site_id": "83c33959-26ad-9d97-05ca-5cff2152dd60",
"membership_number": "1234567890",
"customer": {
"id": "72903330-0558-55f8-7ce7-be251795bf36",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1918-07-24",
"brand_id": "5670838a-d12b-7adf-1c25-19509c495482",
"site_id": "ddbe0d93-12f9-2239-4a93-fe8c33249674",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "4041ce18-ceb1-f819-4252-7870d4b5a583",
"name": "VIP",
"color": "ff6634"
},
{
"id": "d3c0410b-fb04-fede-e542-2c0eff5e6f36",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1908-10-03T05:14:56.0Z",
"created_at": "1918-11-21T21:43:37.0Z",
"updated_at": "1920-06-28T12:49:36.0Z",
"deleted_at": "1898-10-19T03:23:59.0Z",
"last_active_at": "1895-02-23T22:07:24.0Z",
"email_verified_at": "1921-11-11T17:05:52.0Z",
"last_check_in": {
"checked_in_at": "1891-09-21T11:38:46.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "7fe150b5-1285-31ad-1efa-f11621e9f7f7",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "veniam pariatur consequat et magna"
},
"members": [
{
"customer_id": "07aa65e4-0a59-b10e-3a2d-f29dd362caa3",
"membership_number": "1234567890"
},
{
"customer_id": "40521a35-d8c2-53e2-9bcc-8f914584cd96",
"membership_number": "1234567890"
}
],
"type": {
"id": "49a4a41a-36fe-dcf7-7b45-5793f92f6794",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "fugiat occaecat elit aliqua dolor",
"brand_id": "836019e1-082c-b591-4431-ff21ca30749c",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"minimum_start_date": "1953-10-19T08:45:51.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "89cc7469-cccd-23af-bb0c-565e227bf063",
"membership_type_id": "4c4b04cd-0a84-0849-b368-59661a8e273f",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"do aute",
"Duis"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1942-10-29T17:53:27.0Z",
"updated_at": "1909-12-05T20:46:40.0Z"
},
{
"id": "945bc75d-ba1b-e348-deac-c92d3db60c5f",
"membership_type_id": "486119e9-29c7-2f60-147b-3ca8b9b80c54",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"exercitation dolore consequat dolore"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1961-04-12T18:26:33.0Z",
"updated_at": "1940-05-24T21:34:01.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1897-02-19T07:52:09.0Z",
"updated_at": "1894-08-02T01:21:30.0Z",
"deleted_at": "1913-12-07T08:31:50.0Z"
},
"rate": {
"id": "94a083fa-f062-1f18-497f-eed588d7c940",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"default_duration": "P1Y",
"private": true,
"created_at": "1954-12-02T07:05:28.0Z"
},
"status": "needs_dd_mandate",
"source": "unknown",
"payment_method": {
"last_4": "occaecat veniam",
"status": "revoked"
},
"start_date": "1926-01-11T22:48:29.0Z",
"end_date": "1906-06-24T02:19:55.0Z",
"created_at": "1959-01-21T12:53:54.0Z",
"basket_id": "68ff59616decbc01250000c9",
"external_ref": "adipisicing elit sit id",
"next_billing_date": "1932-01-19T16:17:35.0Z",
"next_charge": {
"id": "d625fb15-0f4a-3e2d-06c7-794022bb3b93",
"amount": 3995,
"currency": "GBP",
"status": "failed",
"billing_period_from": "1941-04-26",
"billing_period_to": "1957-01-03"
},
"attention_reason": "setup_unpaid"
},
{
"id": "a257efba-361e-a350-0ea8-da2980f86581",
"site_id": "dd2b8fed-04e5-724a-6e86-62250e2668d0",
"membership_number": "1234567890",
"customer": {
"id": "50ddc75b-0857-31a0-cba2-48ff3e15e673",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1965-06-19",
"brand_id": "d9295986-95d7-db09-838a-e92ff5367bdd",
"site_id": "dbf47152-9cb7-e783-2795-6dbb9e9a39ed",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "bada3855-4b20-6c5c-5f99-a7864db48521",
"name": "VIP",
"color": "ff6634"
},
{
"id": "37b4bfe1-c4a9-7441-0e3a-27d2a2dac83c",
"name": "VIP",
"color": "ff6634"
},
{
"id": "55a51496-eb93-fedc-4e83-f19d0eaa3d95",
"name": "VIP",
"color": "ff6634"
},
{
"id": "ee373d7e-985a-ca38-e303-c6d5b7d951f2",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1944-06-27T11:20:03.0Z",
"created_at": "1946-12-06T05:10:57.0Z",
"updated_at": "1905-04-07T17:44:47.0Z",
"deleted_at": "1902-01-12T05:03:27.0Z",
"last_active_at": "1948-05-12T03:21:59.0Z",
"email_verified_at": "1940-09-25T19:44:32.0Z",
"last_check_in": {
"checked_in_at": "1969-09-27T02:45:36.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "c014dd84-02ef-88d7-b78e-c0293699cdd4",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "Lorem cillum"
},
"members": [
{
"customer_id": "069097b8-16fd-5c7b-84f5-cf08c28eb680",
"membership_number": "1234567890",
"is_lead": false
},
{
"customer_id": "88751d53-9e74-e340-9de1-be2056dc06d7"
}
],
"type": {
"id": "dc5bbe13-83b8-2dc7-3ab7-4264c8fbe82d",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "nostrud reprehenderit amet sunt nisi",
"brand_id": "edd377d8-da0d-7d52-5b53-e446508cf127",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "public",
"minimum_start_date": "1910-08-14T11:24:45.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "b4fc3d77-faed-f9de-8246-2814f6dfc327",
"membership_type_id": "a13a201e-69b6-fcab-5dd1-e3f1ce0146a7",
"name": "Standard rate",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"created_at": "1936-09-04T14:19:26.0Z"
},
{
"id": "f82ff0f3-85e9-f23c-ebb8-3057631ee05f",
"membership_type_id": "ccbd51f3-2baa-b65b-47aa-e57736e35bf5",
"currency": "GBP",
"tax": 1250,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"private": true,
"created_at": "1930-01-08T05:18:43.0Z"
},
{
"id": "0f4b3c08-7fc0-328b-274f-66c2c0040326",
"price": 5000,
"joining_fee": 1000,
"processors": [
"in ut ea aliquip",
"cillum est ut tempor"
],
"default_duration": "P1Y"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1941-05-08T10:42:25.0Z",
"updated_at": "1968-10-06T11:09:06.0Z",
"deleted_at": "1927-06-28T10:50:41.0Z"
},
"rate": {
"id": "6b0edf8a-4f68-13ee-a52a-8c72e050ac03",
"membership_type_id": "25b1fa0a-83d6-e6e4-d03d-30f35118ab16",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true
},
"status": "inactive",
"source": "app",
"payment_method": {
"id": "dolore",
"type": "card",
"last_4": "Excepteur eu non proident do",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1931-08-21T14:21:35.0Z",
"end_date": "1895-11-11T15:26:48.0Z",
"basket_id": "68ff59616decbc01250000ca",
"next_billing_date": "1915-09-04T01:28:55.0Z"
},
{
"type": {
"id": "6d65b5a6-94c7-f90b-706b-93359658e2e1",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "dolore officia qui proident",
"brand_id": "821c8eca-2c5c-d711-c46c-2f858f810b26",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "private",
"minimum_start_date": "1933-06-11T16:17:47.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "cadb22ca-f441-9b89-5b2a-890af684e0e4",
"membership_type_id": "e6b52503-1a02-f7d5-8236-7f10ced6f31c",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"sunt",
"quis Excepteur esse adipisicing",
"consequat nisi",
"officia voluptate ut"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1932-10-28T10:25:47.0Z",
"updated_at": "1956-10-22T18:02:08.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1947-10-24T09:14:04.0Z",
"updated_at": "1935-01-01T20:17:40.0Z",
"deleted_at": "1902-04-24T01:01:46.0Z"
},
"created_at": "1962-09-30T09:57:54.0Z",
"basket_id": "68ff59616decbc01250000cb"
},
{
"id": "26b4ae5b-3be2-1ebc-f839-1ba93bf6b0b0",
"site_id": "862ae585-602f-f65b-989a-dcc650914f83",
"membership_number": "1234567890",
"customer": {
"id": "5a1c4271-d626-4416-ed3f-1be3d320fa76",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1938-10-04",
"brand_id": "7bb9c359-ea26-9bb8-a0bd-8c349bcfda6a",
"site_id": "ca609a20-4c36-c7f7-5062-fbf8abd535ac",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "fa1ab70e-afe9-4914-0758-a49626dbc2fc",
"name": "VIP",
"color": "ff6634"
},
{
"id": "4669cbf2-7de7-fc53-25e8-df414d4e97f0",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1927-03-25T09:37:18.0Z",
"created_at": "1909-04-06T12:02:48.0Z",
"updated_at": "1944-03-01T01:45:14.0Z",
"deleted_at": "1904-09-20T12:01:41.0Z",
"last_active_at": "1949-03-01T06:46:45.0Z",
"email_verified_at": "1902-06-04T12:04:48.0Z",
"last_check_in": {
"checked_in_at": "1936-01-25T05:55:54.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "0d882ab3-d5dc-4cfc-61ac-daf30cb7708c",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "eiusmod proident amet dolor Excepteur"
},
"members": [
{
"membership_number": "1234567890"
},
{
"customer_id": "fc56924f-8662-a6e7-bd13-33cffae11be2",
"membership_number": "1234567890",
"is_lead": false
},
{
"customer_id": "19871fc2-acc0-7bf0-5ec3-1882df88f1fa",
"is_lead": false
}
],
"type": {
"id": "de9729c2-c921-9903-cb71-7440a33d8def",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "esse ut qui",
"brand_id": "ede8c6b2-ac21-343a-cf8d-cb3c0e85c0f8",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1962-06-22T12:29:56.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "dd63e8a7-caca-decc-6d42-ed3609abd5b2",
"membership_type_id": "6552c923-efd7-7a86-5590-876313a1e9a0",
"name": "Standard rate",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"qui sit pariatur",
"veniam nisi magna reprehenderit in",
"do reprehenderit sint"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1948-10-31T20:30:40.0Z"
},
{
"id": "cc126b99-1c8a-82eb-55c0-0911025ac329",
"membership_type_id": "364fd2e7-0139-d124-67d8-982eb6403dc8",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [],
"private": true,
"created_at": "1928-12-14T19:29:56.0Z"
},
{
"id": "e583a34c-0552-5ae7-ee1f-f06afbc4239f",
"membership_type_id": "426ceacc-3efa-fba7-0770-dbca588488a9",
"currency": "GBP",
"price": 5000,
"tax": 1250,
"processors": [
"fugiat",
"aute est elit"
],
"default_duration": "P1Y",
"created_at": "1939-12-30T07:45:54.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1890-09-17T12:16:34.0Z",
"updated_at": "1903-08-29T18:40:37.0Z",
"deleted_at": "1949-06-15T03:08:02.0Z"
},
"rate": {
"name": "Standard rate",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"processors": [],
"default_duration": "P1Y",
"created_at": "1932-10-10T08:43:21.0Z",
"updated_at": "1940-01-11T14:01:23.0Z"
}
}
],
"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"
}
}getMembershipUse this endpoint to retrieve a Membership by its ID.
membershipIdThe ID of the membership
{
"data": {
"id": "e14eb9bd-57e8-430a-bf46-c96f10a3279b",
"site_id": "850b8a85-b892-cd34-3d02-c989dbe13c5a",
"membership_number": "1234567890",
"customer": {
"id": "bbf5608d-211f-7cc5-edf4-1d3439f20d08",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1940-06-14",
"brand_id": "d7101239-dc73-dbe7-3046-50b20bee9ef9",
"site_id": "f1810fdf-1ad6-2414-0c05-95e7ed5e7ae5",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "42ab085b-a3d7-a1a8-bbf6-de32d10e423f",
"name": "VIP",
"color": "ff6634"
},
{
"id": "ddb24065-a951-119a-0cac-253e9c9413a1",
"name": "VIP",
"color": "ff6634"
},
{
"id": "b36a44e2-7372-f389-7300-351e60bb4519",
"name": "VIP",
"color": "ff6634"
},
{
"id": "367d308d-a7cb-2d42-38fb-10994204fde0",
"name": "VIP",
"color": "ff6634"
},
{
"id": "a3134606-8370-f77a-9193-424bc4120787",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1941-10-26T16:37:07.0Z",
"created_at": "1938-07-06T03:49:44.0Z",
"updated_at": "1963-04-24T21:20:22.0Z",
"deleted_at": "1916-06-28T16:43:02.0Z",
"last_active_at": "1933-08-15T07:19:09.0Z",
"email_verified_at": "1911-10-06T21:30:35.0Z",
"last_check_in": {
"checked_in_at": "1939-05-13T21:06:47.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "d870fb61-b415-00ef-26b5-ed194bd47e26",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo.jpg"
},
"external_ref": "occaecat ipsum"
},
"members": [
{
"customer_id": "0b365d83-6dcb-cd94-f671-e2db5ff2731b",
"membership_number": "1234567890"
},
{
"is_lead": false
}
],
"type": {
"id": "583228b0-bbd6-9aef-db38-4fa06772fea1",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "esse in ipsum minim sit",
"brand_id": "1c20f006-9115-4fa2-7b9b-3054e193b55e",
"offline_payments": false,
"disable_confirmation_email": false,
"private": true,
"visibility": "private",
"minimum_start_date": "1897-04-09T05:07:56.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "759cde00-d604-cb0a-5259-cf8ef1fcffd2",
"name": "Standard rate",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"created_at": "1909-07-21T23:32:48.0Z",
"updated_at": "1964-03-26T07:21:03.0Z"
},
{
"id": "8b187c4f-750f-9da3-4516-0fba3f3f4ee2",
"membership_type_id": "2a9269b7-e28a-7a33-f0c9-03b7f61f92e3",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"processors": [
"veniam consectetur occaecat laboris Excepteur"
],
"default_duration": "P1Y"
},
{
"id": "a587b65d-3274-3c92-2f8a-d22a1502fef2",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"tax": 1250,
"billing_frequency": "P1M",
"default_duration": "P1Y",
"private": true,
"updated_at": "1909-07-19T12:27:06.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1912-07-26T19:24:42.0Z",
"updated_at": "1910-03-04T21:59:04.0Z",
"deleted_at": "1894-02-21T12:48:36.0Z"
},
"rate": {
"id": "07d8ca5b-f8a8-c9c8-009f-b89682b66bed",
"membership_type_id": "67df955e-e275-0ac6-b5b9-5f4b0930c52d",
"name": "Standard rate",
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"pariatur quis in ut sed",
"voluptate in est id irure"
]
},
"status": "expired",
"source": "app",
"payment_method": {
"id": "reprehenderit tempor est aute",
"type": "card",
"last_4": "in nulla eu anim do",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1956-11-03T10:57:33.0Z",
"end_date": "1942-05-06T13:51:37.0Z",
"created_at": "1938-04-29T11:27:54.0Z",
"basket_id": "68ff59616decbc01250000cc",
"external_ref": "reprehenderit magna dolore irure",
"next_billing_date": "1922-08-08T06:41:51.0Z",
"next_charge": {
"id": "418ae2ca-6687-246d-0f66-89dc9f3e4568",
"amount": 3995,
"currency": "GBP",
"status": "failed",
"billing_period_from": "1937-06-07",
"billing_period_to": "1958-01-31"
},
"attention_reason": "no_mandate"
}
}{
"message": "The requested resource could not be found"
}actionAddMembershipChargePaymentThis endpoint allows a manual (off-Trybe) payment to be recorded against a membership charge.
chargeIdThe ID of the charge
payment_type_idThe ID of the custom payment type this payment should be recorded as
amountThe amount of the payment
{
"data": {
"id": "c9c677ec-8a18-f700-23ce-d5ea7f95d584",
"membership": {
"id": "faeccb88-495d-9214-057a-b8689a1b681d",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "02e75823-f932-f218-fb66-3653bc00b7b5",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "68ff59616decbc01250000cd"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "ex",
"can_download_receipt": true,
"amount_refunded": "velit ipsum consectetur elit pariatur",
"refunded": "ipsum Excepteur reprehenderit mollit magna",
"refunds": [
{
"id": "32bb1cea-59ff-fcd1-d826-d4b6c10c8fbf",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "c60223f8-2b5f-3dc8-fe8a-e2b3ba97d6b8",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1952-04-14T07:38:58.0Z",
"updated_at": "1906-08-21T16:19:27.0Z"
},
{
"id": "c2720a67-3ac3-8078-252c-15a21ad9f746",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1955-01-01T08:15:09.0Z",
"updated_at": "1943-03-14T20:03:53.0Z"
},
{
"id": "00a8b25e-6b1d-8b88-6052-7a51547a5242",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "7d1b1638-bd0d-fc46-87ee-9ec69f3b3ccd",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1918-07-26T18:58:54.0Z",
"updated_at": "1926-11-19T10:52:58.0Z"
},
{
"id": "63a4ac53-e55e-0ec8-68bd-f38370bdb706",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1904-03-29T07:16:12.0Z",
"updated_at": "1913-06-24T07:50:14.0Z"
}
],
"site_id": "c4261777-08eb-276f-6a5a-289ec594d2b1",
"billing_period_from": "1910-05-10",
"billing_period_to": "1930-04-14",
"processing_at": "1937-06-19T13:48:05.0Z",
"created_at": "1964-07-26T10:40:13.0Z",
"updated_at": "1910-10-30T08:15:12.0Z"
}
}{
"message": "The requested resource could not be found"
}actionProcessMembershipChargeThis endpoint allows a membership charge to be processed manually.
chargeIdThe ID of the charge
{
"data": {
"id": "1b24e9e6-5e4d-e4be-0f63-3698aa0f0a62",
"membership": {
"id": "c218d4f3-2d11-ebcb-ba7a-d1c8b3532654",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "99780d93-e8ab-6762-93cd-25ea1d3c3759",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"processor_type": "Cash",
"processor_type_id": "68ff59616decbc01250000ce"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "ut qui",
"can_download_receipt": false,
"amount_refunded": "laboris",
"refunded": "velit aliquip",
"refunds": [
{
"id": "51f0243a-999e-c94c-0443-00650e3553c8",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "5688859a-f32d-0ac7-80ac-99177f241eca",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1962-05-02T02:46:09.0Z",
"updated_at": "1958-08-23T02:30:37.0Z"
},
{
"id": "118b13d4-0021-35f0-d0ae-0ce45e838c76",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1948-08-17T21:49:30.0Z",
"updated_at": "1898-08-12T13:23:01.0Z"
}
],
"site_id": "d03db136-ec6e-6dc0-79de-d5c3af5be437",
"billing_period_from": "1904-04-08",
"billing_period_to": "1922-12-23",
"processing_at": "1951-07-30T21:28:48.0Z",
"created_at": "1897-03-25T22:52:42.0Z",
"updated_at": "1925-07-19T22:17:37.0Z"
}
}{
"message": "The requested resource could not be found"
}actionRetryMembershipChargeThis endpoint allows a membership charge to be retried manually.
chargeIdThe ID of the charge
{
"data": {
"id": "f165a717-1e19-f8b9-38bb-097add9f5ccf",
"membership": {
"id": "415d2936-4db8-94c0-84b7-66f85a9efb5d",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "47ac3145-ab4b-0b8a-678f-98b419db6903"
},
"processor": "adyen",
"processor_data": {
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "68ff59616decbc01250000cf"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "proident aute eiusmod",
"can_download_receipt": true,
"amount_refunded": "dolor deserunt anim sunt",
"refunded": "cillum Ut ad nostrud",
"refunds": [
{
"id": "7614660f-03af-64d3-941c-18832805d0c7",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1924-09-30T01:49:49.0Z",
"updated_at": "1894-01-01T14:10:43.0Z"
},
{
"id": "0ac648a2-e89e-9015-3a69-29d46218a5ae",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "626e47ee-5f0c-f5ac-63f9-206fab2d243d",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1927-03-04T15:22:38.0Z",
"updated_at": "1966-12-08T10:11:39.0Z"
}
],
"site_id": "42235111-17fb-7369-acd3-a306ee263e80",
"billing_period_from": "1946-05-06",
"billing_period_to": "1913-08-12",
"processing_at": "1903-01-19T15:34:24.0Z",
"created_at": "1947-01-25T21:51:03.0Z",
"updated_at": "1928-09-09T17:01:01.0Z"
}
}{
"message": "The requested resource could not be found"
}