A Membership represents a membership belonging to one or more Customers.
The ID of the membership
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
The basket ID which was used to purchase this membership, if applicable.
end_dateThe date which the membership ends
An external reference for this membership.
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.
next_billing_dateThe 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.
payment_methodDetails 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 ID of the site this membership belongs to
Where the membership was created
Possible values are self_signup, app, import and unknown
The date which the membership starts
Possible values are active, needs_dd_mandate, needs_attention, reserved, inactive, expired and upcoming
A URL to a page where the member can provide their payment details.
The datetime which the membership was created
""listMembershipsThis endpoint lists the Memberships which are associated to the provided site.
The Memberships were successfully retrieved
{
"data": [
{
"id": "e3fca7be-410b-4c98-c674-7193aca36aa2",
"attention_reason": "payment_failed",
"basket_id": "699dbe7beca7e501360000a3",
"customer": {
"id": "64e9c3a0-db71-eb80-c9f2-e6115cb0bb0c",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1920-12-28",
"brand_id": "2c2c2dbb-f1d3-1595-211b-fe8d0d9682d6",
"site_id": "fe75bbfd-2904-748b-7a93-2c762d523231",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "a0e6e6e0-8f4d-a7f3-e8b0-43b4eb72b0a5",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "6454725f-6520-214b-eff9-53fcc8640ebd",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "9a100248-cac7-ec67-bb32-11b1b849595e",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "0438dee7-60bf-0295-d007-836037f76f24",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "5a1a2ea2-27d9-3dd0-0b38-e8327561c619",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1901-09-15T04:38:44.0Z",
"created_at": "1956-03-20T10:35:17.0Z",
"updated_at": "1926-10-06T12:59:38.0Z",
"deleted_at": "1909-11-26T06:09:23.0Z",
"last_active_at": "1896-03-07T15:36:08.0Z",
"email_verified_at": "1942-08-03T18:22:52.0Z",
"last_check_in": {
"checked_in_at": "1949-11-23T05:42:50.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "a53c995c-f45f-5a54-3bae-f7b9766e8aa3",
"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": "nostrud Lorem"
},
"end_date": "1963-11-20T08:07:22.0Z",
"external_ref": "aute laborum sint",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1936-09-23T01:42:30.0Z",
"next_charge": {
"id": "d1bf4a04-44e5-baa1-59e6-d79803d6802c",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1929-10-15",
"billing_period_to": "1947-11-18"
},
"payment_method": {
"id": "eu qui in reprehenderit esse",
"type": "card",
"last_4": "nisi reprehenderit incididunt",
"card_brand": "amex"
},
"rate": {
"id": "38e0f47d-2472-666a-1978-c8f4121c05f4",
"membership_type_id": "0f175910-71ea-75e5-bf58-32651cc71206",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1906-06-23T07:31:58.0Z",
"updated_at": "1934-07-17T16:31:26.0Z"
},
"site_id": "3e3db6ae-0da8-c8b1-8151-7466f66d7d6d",
"source": "app",
"start_date": "1952-09-12T07:01:38.0Z",
"status": "inactive",
"status_updated_at": "1922-12-29T09:23:10.0Z",
"type": {
"id": "0255055a-85c0-b1c1-5b4a-d0d28dbe4bed",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "incididunt eu nisi amet",
"brand_id": "a3130c97-eaa8-d674-2222-5298785d7eed",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"minimum_start_date": "1937-12-20T20:35:22.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "04213acd-3aa5-4870-e4d4-c08a3247aa9d",
"membership_type_id": "aec1cd05-8f93-e5da-9a2c-a860d25dbfcf",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"culpa aliqua ad consequat Lorem",
"sint velit reprehenderit commodo mollit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1895-01-15T07:37:47.0Z",
"updated_at": "1966-10-24T03:25:03.0Z"
},
{
"id": "964d33ae-4554-1635-71b5-4e177f3c837a",
"membership_type_id": "93372544-5147-b6ec-c2f7-adab7f72b571",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"in sint Lorem velit",
"exercitation magna reprehenderit",
"fugiat culpa"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1914-08-02T06:57:38.0Z",
"updated_at": "1893-07-22T13:46:05.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1930-09-28T18:48:28.0Z",
"updated_at": "1956-03-30T16:32:03.0Z",
"deleted_at": "1903-06-14T02:48:31.0Z"
},
"payment_details_url": "reprehenderit ipsum consectetur",
"created_at": "1953-06-06T21:25:29.0Z"
},
{
"id": "7df45b60-91b7-f1aa-cccb-51630e63ca0c",
"attention_reason": "mandate_revoked",
"basket_id": "699dbe7beca7e501360000a4",
"customer": {
"id": "8935ddab-8992-1454-3472-00fa3006b9ef",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1956-01-28",
"brand_id": "fe1f5c01-7847-e674-8d41-e1695e091189",
"site_id": "54be949f-dcaf-8ce6-278e-a981c533a6e5",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1967-06-26T14:54:05.0Z",
"created_at": "1942-10-12T13:50:13.0Z",
"updated_at": "1898-12-18T15:40:07.0Z",
"deleted_at": "1921-08-09T09:11:05.0Z",
"last_active_at": "1951-05-27T16:36:05.0Z",
"email_verified_at": "1909-12-05T02:40:01.0Z",
"last_check_in": {
"checked_in_at": "1953-09-21T12:14:22.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "0b681ad9-4e17-fe58-dc2c-91012c77d344",
"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": "est Lorem sunt amet nulla"
},
"end_date": "1957-07-14T04:17:24.0Z",
"external_ref": "ut eu id minim",
"members": [
{
"customer_id": "7b71bf9f-1512-8f1a-10e6-b5f26ab1d8bf",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "56dff4bb-2b9a-9d66-0e50-1554a37192a6",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "cc10e697-1f99-c789-2668-04874bb55c9b",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "d5c42fee-282b-c796-ee58-55207b113374",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "b3b6ff82-8506-964d-3063-fd352935de49",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1914-06-30T23:49:53.0Z",
"next_charge": {
"id": "49a78fdb-f73f-0cd7-c0a3-778e3bb7d83b",
"amount": 3995,
"currency": "GBP",
"status": "failed",
"billing_period_from": "1942-08-23",
"billing_period_to": "1893-08-25"
},
"payment_method": {
"id": "magna sit",
"type": "card"
},
"rate": {
"id": "082e35a2-a74a-b9e1-813b-88eb5886d42e",
"membership_type_id": "3a62f7d5-c0ea-1b04-bb53-24eb49151238",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ex ipsum fugiat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1950-12-05T13:49:54.0Z",
"updated_at": "1900-09-02T08:14:55.0Z"
},
"site_id": "8c95640f-0c10-a230-2379-010af521e713",
"source": "import",
"start_date": "1952-11-07T18:40:56.0Z",
"status": "active",
"status_updated_at": "1915-11-28T13:24:27.0Z",
"type": {
"id": "3bc07895-7a4a-a02a-0be2-cf53b6a6c9a6",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "veniam et aute consectetur",
"brand_id": "ba926fa3-e223-109f-50c6-37541dce3124",
"offline_payments": true,
"disable_confirmation_email": false,
"private": true,
"minimum_start_date": "1937-05-08T01:42:05.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1968-04-08T03:55:10.0Z",
"updated_at": "1929-07-02T16:07:55.0Z",
"deleted_at": "1904-11-30T23:12:26.0Z"
},
"payment_details_url": "ipsum Excepteur veniam",
"created_at": "1914-11-10T15:51:15.0Z"
},
{
"id": "d10de0f3-95ee-a93d-6810-8073b679208c",
"attention_reason": "payment_outstanding",
"basket_id": "699dbe7beca7e501360000a5",
"customer": {
"id": "da6d9905-becc-dcee-5961-e562039a2d36",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1967-02-06",
"brand_id": "67aabdd0-172b-27fd-a6ce-a5e087943843",
"site_id": "99395a78-a6b7-d7a0-a533-81760a5bc8d6",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "9f568b86-57cf-e857-8ade-9efd8ec2a6aa",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "44f8f3c8-ce97-9493-67f7-7e647088614e",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1938-09-23T14:38:03.0Z",
"created_at": "1939-07-23T04:51:41.0Z",
"updated_at": "1956-03-21T14:47:57.0Z",
"deleted_at": "1969-10-01T13:29:55.0Z",
"last_active_at": "1958-01-18T05:19:38.0Z",
"email_verified_at": "1898-02-26T06:04:16.0Z",
"last_check_in": {
"checked_in_at": "1946-08-20T06:12:57.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "64598aad-059e-0248-154b-6c60aae6b336",
"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": "in Duis non minim"
},
"end_date": "1919-03-08T20:29:06.0Z",
"external_ref": "ullamco ex Excepteur aliqua",
"members": [
{
"customer_id": "2ecaaa33-07a8-d35c-a993-7707822ffb9e",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1898-07-14T06:17:42.0Z",
"next_charge": {
"id": "a03a82d2-1e23-f7d4-471d-200adf80f26f",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1948-08-11",
"billing_period_to": "1924-05-08"
},
"payment_method": {
"id": "do",
"type": "direct_debit"
},
"rate": {
"id": "ce9a404f-205b-1cf8-aac2-ca66d7f28d78",
"membership_type_id": "1d60f0f9-f1cb-f908-d358-3c600170898b",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Excepteur esse irure occaecat",
"labore dolore cillum sint"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1947-11-14T05:35:14.0Z",
"updated_at": "1930-05-12T11:05:22.0Z"
},
"site_id": "5d3534d2-f7a3-983c-daec-4e3eb6a880ac",
"source": "self_signup",
"start_date": "1935-10-16T01:59:08.0Z",
"status": "expired",
"status_updated_at": "1946-08-09T09:40:47.0Z",
"type": {
"id": "1f9eecef-e926-3347-b1b4-95fb267d369f",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "incididunt cupidatat sunt Lorem laborum",
"brand_id": "512ca798-68d0-8db9-60bf-d87b481563f5",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "public",
"minimum_start_date": "1918-05-30T03:01:50.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "53ea0e09-a3fc-4f74-84dd-9441cdd9fccb",
"membership_type_id": "96f16cb6-4645-1390-26b3-6cc0dcc3f0ad",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1966-12-08T08:05:33.0Z",
"updated_at": "1927-02-09T15:32:18.0Z"
},
{
"id": "8ceecd3b-f9fc-ebc6-5dfa-27124ffdf5ab",
"membership_type_id": "c12569a2-3b21-4429-6295-5b9f41e2491d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"eu consectetur cupidatat culpa irure"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1922-02-22T17:13:47.0Z",
"updated_at": "1905-04-25T14:34:46.0Z"
},
{
"id": "11e08876-8d0f-e2d5-6c07-c56eb9fd00db",
"membership_type_id": "aa9ec1f9-8295-8d6c-f0e0-58f36d93c885",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1902-09-08T13:58:08.0Z",
"updated_at": "1953-06-20T15:38:19.0Z"
},
{
"id": "77080cd7-c562-9023-324b-4aaa41d8d07d",
"membership_type_id": "3eca9ca6-d27e-6ae2-9fa8-8dc33b8aff4d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"labore in eu ad esse",
"Ut non do",
"mollit aliqua sed",
"magna nulla",
"laboris laborum ad"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1905-12-09T23:27:54.0Z",
"updated_at": "1964-04-16T17:40:26.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1950-09-19T08:42:01.0Z",
"updated_at": "1968-06-15T15:20:42.0Z",
"deleted_at": "1921-06-20T01:43:19.0Z"
},
"payment_details_url": "in",
"created_at": "1912-07-24T13:38:51.0Z"
},
{
"id": "edb67655-cf29-02a3-6668-3d665aa0798d",
"attention_reason": "site_id",
"basket_id": "699dbe7beca7e501360000a6",
"customer": {
"id": "8628fd6f-5e6c-925e-082b-d52f7721ba05",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1956-04-20",
"brand_id": "61b1a7b7-50bf-83de-f526-bd4b526b73ff",
"site_id": "d357f656-f3a0-72b7-996d-b5d0c57d4773",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "ac1859c3-b66c-f56a-8f6f-fe36e65bd6a5",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "02447711-9b86-722d-1fe9-82dd9b7b0787",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1942-12-15T12:31:06.0Z",
"created_at": "1962-11-27T15:28:45.0Z",
"updated_at": "1939-06-25T22:56:40.0Z",
"deleted_at": "1961-01-12T21:50:34.0Z",
"last_active_at": "1961-09-06T22:30:41.0Z",
"email_verified_at": "1901-07-25T10:44:18.0Z",
"last_check_in": {
"checked_in_at": "1910-07-31T07:09:47.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "4c34edc2-82c4-6ab9-14c2-8acac4c70603",
"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": "culpa ut sint in aliquip"
},
"end_date": "1920-02-20T01:38:05.0Z",
"external_ref": "nostrud deserunt Excepteur in velit",
"members": [
{
"customer_id": "ad5d0e8b-cd33-4e4f-3add-78f523647a9e",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "33f6593c-f7d3-79ce-3789-6148ca739dd4",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "2ad4ff1a-4289-b9aa-e717-f3fb874cecac",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "65a6a125-4874-698c-c9e9-45b31861601a",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "ac33f1fc-89aa-1fd0-8c73-9d95d3d47dfb",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1957-11-27T22:22:02.0Z",
"next_charge": {
"id": "364e35f8-09bb-04ea-d3c8-1ec3fddf8f97",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1898-04-08",
"billing_period_to": "1947-04-06"
},
"payment_method": {
"id": "ex",
"type": "direct_debit",
"last_4": "anim aliquip",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "95553d66-e634-5f23-fc38-058735b1af0e",
"membership_type_id": "36643213-3f8b-82b8-40c4-236eecc15ada",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"et qui aute in nostrud",
"qui amet ipsum ut laborum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1958-01-15T06:48:17.0Z",
"updated_at": "1904-05-07T12:57:10.0Z"
},
"site_id": "770d85ce-3fbc-4cb1-3f5c-69ca41d8d9f5",
"source": "unknown",
"start_date": "1965-05-14T08:27:56.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1918-06-01T18:46:08.0Z",
"type": {
"id": "65388e9b-8aa0-13d4-d6ce-c1be444f0c06",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "Ut ea enim Excepteur",
"brand_id": "7c6dbdd6-628c-0009-2f59-583a586fb027",
"offline_payments": false,
"disable_confirmation_email": true,
"private": false,
"visibility": "public",
"minimum_start_date": "1910-08-21T12:04:44.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "ee385cd2-fe2f-6e95-cc04-90d0bf5e4429",
"membership_type_id": "289dcf0a-a171-c0a0-0a65-1a0c4154f76a",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-07-18T18:49:39.0Z",
"updated_at": "1928-02-06T01:31:25.0Z"
},
{
"id": "2922dece-8aae-716b-9035-ea6cd6334047",
"membership_type_id": "0bf5cb5e-e94f-13b3-c888-0cc3a05eae74",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Ut Duis ea magna nisi"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1948-09-09T23:04:12.0Z",
"updated_at": "1912-12-31T14:01:02.0Z"
},
{
"id": "ef5e4e0d-c913-7cdd-d48e-40e077775795",
"membership_type_id": "a30b59b9-dd95-5b68-a7cd-1446c24e3214",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"labore elit dolor reprehenderit Excepteur",
"consectetur",
"cupidatat laboris culpa aliqua",
"do et non proident cillum",
"ut"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1933-03-12T19:21:13.0Z",
"updated_at": "1955-05-30T04:32:01.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1948-05-13T14:44:46.0Z",
"updated_at": "1958-09-26T05:27:19.0Z",
"deleted_at": "1955-07-19T09:05:01.0Z"
},
"payment_details_url": "Duis",
"created_at": "1914-07-06T15:11:01.0Z"
},
{
"id": "d946caed-cda6-6e49-9887-ab8a92824908",
"attention_reason": "site_id",
"basket_id": "699dbe7beca7e501360000a7",
"customer": {
"id": "960f94c7-e629-af5f-358e-7caa113acd1f",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1906-12-18",
"brand_id": "7f6e6752-b817-e6d4-fcf8-7d5d03aa2afd",
"site_id": "fe518f8e-8f4c-a70e-b711-c24cbe0db24e",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "13463e5d-97b9-ae89-b79b-f50a147c3d36",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "0f20f7a7-f977-6e6b-68e8-4a51de41a797",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1928-05-15T01:39:55.0Z",
"created_at": "1926-03-29T16:01:40.0Z",
"updated_at": "1923-05-03T10:32:17.0Z",
"deleted_at": "1891-05-14T09:41:41.0Z",
"last_active_at": "1922-07-12T01:38:22.0Z",
"email_verified_at": "1968-01-07T02:24:34.0Z",
"last_check_in": {
"checked_in_at": "1934-02-11T10:08:11.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "1771bab1-69ec-d699-7b9e-b8009f8cede6",
"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": "elit"
},
"end_date": "1959-03-11T06:41:57.0Z",
"external_ref": "consectetur labore id",
"members": [
{
"customer_id": "9fd700fe-b62d-ad94-e519-81f127119ad3",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "3c1035d2-f0fc-b922-09ef-b2e44744727b",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "9c30ae14-534d-8136-b8e2-ae04d549aced",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1940-04-14T18:11:05.0Z",
"next_charge": {
"id": "c8be5163-9b2b-4c3b-405b-2aa752670245",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1917-01-21",
"billing_period_to": "1916-09-03"
},
"payment_method": {
"id": "Duis dolor sunt deserunt",
"type": "direct_debit",
"last_4": "qui pariatur aute",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "c1237f74-8a95-3d33-f87a-09735b3b564c",
"membership_type_id": "dc367c21-1926-c112-02a2-303eff161b32",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1911-10-01T22:12:09.0Z",
"updated_at": "1965-01-28T08:19:45.0Z"
},
"site_id": "9da05989-0c6e-0c53-c207-25434c8e2706",
"source": "self_signup",
"start_date": "1924-03-25T11:22:25.0Z",
"status": "reserved",
"status_updated_at": "1893-08-29T23:10:19.0Z",
"type": {
"id": "109cdcd5-a511-18ac-a509-79f1ac863531",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "cupidatat eu consequat",
"brand_id": "8c2a0829-d729-bc29-6340-9a0f5166deae",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1964-07-23T18:08:08.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "5676a548-3f93-e530-7684-07fc5f2b626b",
"membership_type_id": "8d48fb07-ea6a-6969-b574-9149e53455ca",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"anim veniam quis ex"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1964-02-23T04:23:35.0Z",
"updated_at": "1964-09-26T21:32:16.0Z"
},
{
"id": "97807a3c-893d-9949-6991-e5467d9272e5",
"membership_type_id": "95810d36-8e62-2f70-ee37-03d91b499a88",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolor",
"elit id qui",
"fugiat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1890-10-11T04:45:05.0Z",
"updated_at": "1935-03-06T10:34:01.0Z"
},
{
"id": "1e8dfab8-f2da-7969-b0cf-2d7e1e73c691",
"membership_type_id": "ed177986-8f7a-9f23-372b-517dad4d6684",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"amet"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1956-10-28T02:53:27.0Z",
"updated_at": "1960-03-08T02:58:20.0Z"
},
{
"id": "22385f05-b22c-c87a-c83e-31a07bda9001",
"membership_type_id": "f7bf3bc7-2d6b-2e0b-6035-3dc751dc9bcb",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolore",
"occaecat eu sit",
"dolor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1936-03-25T08:39:59.0Z",
"updated_at": "1950-01-13T04:01:40.0Z"
},
{
"id": "34775caa-9a2c-b525-ae4a-69c3b9f0a748",
"membership_type_id": "cffe550a-3eac-ef2b-3c0c-5b1e4f65a3e2",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"culpa cillum dolor non ut",
"enim Excepteur"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1925-09-29T03:35:20.0Z",
"updated_at": "1939-02-19T10:28:29.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1941-11-04T20:03:47.0Z",
"updated_at": "1915-01-22T12:34:26.0Z",
"deleted_at": "1917-04-01T13:17:51.0Z"
},
"payment_details_url": "consequat mollit ipsum",
"created_at": "1951-05-08T13:10:45.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": "ca19a99a-08c5-a5dc-9f5b-2aff37092bb2",
"attention_reason": "mandate_revoked",
"basket_id": "699dbe7beca7e501360000a8",
"customer": {
"id": "62930ffb-43dd-9a21-5fb3-cbd3ac5f68e0",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1919-10-03",
"brand_id": "f99762ba-796b-1716-e0b2-bfae35b8fefc",
"site_id": "9b23f433-cf99-1fb9-1645-0aca92186e5b",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "e2bc602c-8562-2ffa-4663-8c8a0e8f1296",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "4eaa2044-fc75-9090-46fa-3da6ccc4b593",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "ff58b6fc-2127-ffe0-84cf-42e56a76c39e",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "c29d8392-e80f-c6d0-8fe2-10c473e8e3e7",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1910-11-06T01:08:55.0Z",
"created_at": "1935-08-06T23:35:03.0Z",
"updated_at": "1890-07-18T17:43:27.0Z",
"deleted_at": "1912-09-18T18:04:10.0Z",
"last_active_at": "1925-03-11T01:18:23.0Z",
"email_verified_at": "1928-11-22T10:34:23.0Z",
"last_check_in": {
"checked_in_at": "1957-12-15T08:33:59.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "9af84dff-61d8-f157-bea1-53216d51dc22",
"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": "velit minim exercitation dolore laboris"
},
"end_date": "1933-04-09T07:49:09.0Z",
"external_ref": "officia deserunt cupidatat esse incididunt",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1892-05-20T15:17:48.0Z",
"next_charge": {
"id": "e45215fa-385e-bf63-4bc2-15b6b8093584",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1905-05-09",
"billing_period_to": "1948-03-06"
},
"payment_method": {
"id": "Excepteur",
"type": "direct_debit",
"last_4": "consectetur incididunt aliquip"
},
"rate": {
"id": "dadafed4-46a3-eb5c-1ead-973b09ace267",
"membership_type_id": "5828fff0-e08f-f639-f4cf-8d41b11fa049",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"mollit commodo labore proident"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1958-05-29T01:14:35.0Z",
"updated_at": "1949-08-23T09:04:55.0Z"
},
"site_id": "29fc23fa-7f39-7e3e-c4fe-ccd88725f180",
"source": "self_signup",
"start_date": "1964-11-04T06:31:15.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1933-10-19T16:08:04.0Z",
"type": {
"id": "cefc36fd-d0ab-42a4-b793-670b168f2b9a",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "ut mollit",
"brand_id": "dddd05e3-9732-64fa-8fb0-986947a84040",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1962-03-26T13:23:55.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "ac661846-930a-0af8-b901-f511942a9e59",
"membership_type_id": "5172b748-6393-740d-5475-dd9f59c9b818",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"sint irure"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1950-12-22T06:15:56.0Z",
"updated_at": "1909-05-17T21:12:46.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1962-05-24T21:28:14.0Z",
"updated_at": "1939-12-31T08:26:07.0Z",
"deleted_at": "1966-05-22T01:55:23.0Z"
},
"payment_details_url": "enim do",
"created_at": "1909-10-07T11:10:28.0Z"
}
}{
"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": "67d815e2-22f6-86d6-fec6-25890f5fec13",
"membership": {
"id": "93f1d28f-11f9-15a0-b469-c74845eb57dc",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "54436bd9-3b75-0d1d-fb4c-6a08bc18ab16",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type_id": "699dbe7ceca7e501360000aa"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "laborum cupidatat elit",
"can_download_receipt": true,
"amount_refunded": -26719308,
"refunded": true,
"refunds": [
{
"id": "4032ff4d-d182-eb23-7f38-6eec417d2e30",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "3782f3bc-bf1a-ae3f-b358-c3a8f5cf3364",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1920-03-28T07:48:52.0Z",
"updated_at": "1922-03-19T22:52:22.0Z"
},
{
"id": "ef83e81a-5483-4d12-ee4a-c95de4023f6b",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1953-12-22T14:20:20.0Z",
"updated_at": "1962-10-18T13:06:51.0Z"
},
{
"id": "5365056b-c003-edf1-c571-ea07d1fb6096",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "68427f19-8f1a-0538-6742-69ca6a91d1c6",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1945-05-29T22:33:24.0Z",
"updated_at": "1944-09-02T07:31:10.0Z"
},
{
"id": "ca413bf7-257f-573b-69cd-b72ef4b2c993",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"refunded_by": {
"id": "cdfc7d7e-8925-7ff9-e26f-d2f4742c3f29",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1921-01-07T21:54:01.0Z",
"updated_at": "1933-09-24T03:52:47.0Z"
},
{
"id": "a7da813a-3749-bd82-ccb6-75b167c737ff",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "b7a797ad-0227-4601-a23d-6afbf2c6e968",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1968-03-29T10:43:56.0Z",
"updated_at": "1909-04-28T10:33:03.0Z"
}
],
"site_id": "34b56206-1984-cb78-dc29-7dbef018c0d8",
"billing_period_from": "1898-06-17",
"billing_period_to": "1965-01-15",
"processing_at": "1962-09-03T06:06:47.0Z",
"created_at": "1908-03-28T04:58:36.0Z",
"updated_at": "1924-06-21T12:49: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": "67847ccd-a0ea-fcbe-2243-d305dbd66761",
"membership": {
"id": "f757d98f-0489-dd97-b472-26bbe2feff4f",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "b44fe609-8828-422c-fb00-26212b7fa87c",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"last_4": 4001,
"processor_type": "Cash"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "tempor adipisicing do reprehenderit laborum",
"can_download_receipt": false,
"amount_refunded": -67700506,
"refunded": true,
"refunds": [
{
"id": "0557c4ef-a93f-e138-12e3-04aa7f070144",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "48df3d49-8f57-db64-f824-5ec6190429f6",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1961-02-21T19:47:37.0Z",
"updated_at": "1961-04-10T16:26:26.0Z"
}
],
"site_id": "629f5b1b-2ba6-89d4-bdca-f164a25e5a5f",
"billing_period_from": "1907-08-30",
"billing_period_to": "1945-08-05",
"processing_at": "1904-08-26T21:32:35.0Z",
"created_at": "1894-06-07T16:17:13.0Z",
"updated_at": "1916-06-23T01:33:36.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": "88019a39-5fb0-d95e-21fc-5002fc7b2374",
"membership": {
"id": "f6609b18-5dc0-eb95-bdf0-f37809726b10",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "93f7f499-ac21-788c-7e36-52103934c4b5"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "699dbe7beca7e501360000a9"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "Excepteur quis ut magna",
"can_download_receipt": false,
"amount_refunded": 81433343,
"refunded": true,
"refunds": [
{
"id": "fa7629d3-1338-bf6f-b616-4c69428c983d",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "db4f7760-12a0-7394-d5da-3b2b0e73c402",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1926-01-08T02:06:10.0Z",
"updated_at": "1968-01-10T23:12:42.0Z"
},
{
"id": "d1a4c05a-25ac-1d23-b06a-19477993a9f9",
"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": "1964-09-27T09:01:12.0Z",
"updated_at": "1965-03-27T21:36:54.0Z"
},
{
"id": "c778cb1c-22f1-7ecb-f2bd-30b0908c86d5",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "898e3b7c-94be-4dca-4091-af9d5c6b1523",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1905-07-12T17:39:12.0Z",
"updated_at": "1892-02-12T04:39:27.0Z"
},
{
"id": "d0edb53b-2d10-5a1c-ba90-ffa6459c12f1",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "02f0b057-1629-75fc-2bbe-2f215097cd8e",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1968-01-13T14:09:26.0Z",
"updated_at": "1947-10-17T20:08:03.0Z"
}
],
"site_id": "60a6fcab-9b7e-8c35-e22b-c5b36ded30e4",
"billing_period_from": "1957-02-27",
"billing_period_to": "1904-09-07",
"processing_at": "1969-11-18T17:47:08.0Z",
"created_at": "1895-11-05T07:03:32.0Z",
"updated_at": "1943-05-11T20:50:20.0Z"
}
}{
"message": "The requested resource could not be found"
}createMembershipSmsThis endpoint sends an SMS message to a membership's lead member. Currently supports sending billing details request messages.
membershipIdThe ID of the membership
message_typeThe type of message to send.
Possible values are billing_details_request
If true, send the SMS even if the membership already has a payment method. Defaults to false.
{
"data": {
"id": "699dbe7ceca7e501360000ab",
"organisation_id": "ffbed6ff-f63e-0f7d-e435-1521f7c9f64d",
"site_id": "6e248b1c-2636-c0db-1f10-a7ce29be4237",
"customer_id": "80793248-7531-a442-e514-7fa011bbe03a",
"from": "Trybe",
"to": "+447123456789",
"message": "nostrud Excepteur",
"message_type": "billing_details_request",
"message_delivered": true,
"created_at": "2024-02-02T12:01:01.0Z",
"sent_at": "2024-02-02T12:01:01.0Z"
}
}{
"message": "The requested resource could not be found"
}{
"errors": {
"aute_1f6": [
"tempor laboris quis exercitation",
"officia eu reprehenderit",
"voluptate sint esse cupidatat Duis",
"qui proident cillum Lorem",
"in adipisicing occaecat"
]
},
"message": "The request didn't pass validation"
}createMembershipSmsPreviewThis endpoint previews an SMS message for a membership.
membershipIdThe ID of the membership
message_typeThe type of the SMS message.
Possible values are billing_details_request
If true, preview the SMS even if the membership already has a payment method. Defaults to false.
{
"data": {
"message": "Your Premium Membership membership is almost ready! Please provide payment details for your membership payments. Set up here: https://example.com/confirm\n",
"site_id": "024930b8-8587-709b-adab-151929e52af1",
"organisation_id": "cd08d3c9-84be-c909-3d28-e4d12e42ec1e"
}
}{
"message": "The requested resource could not be found"
}