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": "f6dba855-82ab-77cd-e2e3-443bfe605bd5",
"attention_reason": "site_id",
"basket_id": "69d7b6c50d3c32014a000617",
"customer": {
"id": "ec29707c-d675-1cf2-bf54-247fbcd7d7b8",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1911-09-11",
"brand_id": "77266be8-f03f-daca-aa92-c48efa471a7d",
"site_id": "a76cfad4-bf93-cd80-cc79-d7546d2828ae",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "2913ec90-c3df-d147-7269-688a158059bc",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "ffcf6d46-c525-cb59-13a0-f4d9cf308c1d",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "65f97e05-3c16-a1d5-05c2-12b5535b52ea",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "e0ba45f5-cd57-6848-7a9d-951126ec5fbd",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1936-01-16T15:41:09.0Z",
"created_at": "1907-06-24T22:10:50.0Z",
"updated_at": "1964-10-03T11:52:54.0Z",
"deleted_at": "1957-06-14T21:35:18.0Z",
"last_active_at": "1903-02-10T10:15:15.0Z",
"email_verified_at": "1898-12-30T14:19:26.0Z",
"last_check_in": {
"checked_in_at": "1911-12-31T01:24:39.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "8d45818d-f4d7-ac10-8a7a-5f693b95395c",
"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": "exercitation anim"
},
"end_date": "1968-12-15T04:50:28.0Z",
"external_ref": "cupidatat Excepteur fugiat eiusmod incididunt",
"members": [
{
"customer_id": "def3cfc2-348c-452b-5eba-e51dd116fbed",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "1e6d3d31-be00-7946-cfba-7dc66a9f1555",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1957-07-26T19:03:07.0Z",
"next_charge": {
"id": "af44799d-271f-2dea-25d0-d0aaa9b67adb",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1959-07-16",
"billing_period_to": "1941-09-10"
},
"payment_method": {},
"rate": {
"id": "06ff2d2e-e61a-9b3f-c8ac-58bdc2b0fdfd",
"membership_type_id": "f3dc4d13-dcae-4a37-22d0-c3091cc5f84a",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolore consequat aliqua",
"in elit reprehenderit labore officia",
"pariatur Ut",
"ut aliqua sed",
"esse et cillum velit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1902-08-02T02:10:12.0Z",
"updated_at": "1957-03-10T01:03:39.0Z"
},
"site_id": "81e39b53-db58-00c3-8256-5cfa22cd62ef",
"source": "import",
"start_date": "1911-10-15T12:42:37.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1912-12-22T03:22:39.0Z",
"type": {
"id": "df5fa857-ff07-469b-20e9-29bf7e78ced2",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "dolor non eu adipisicing",
"brand_id": "dda26b1c-888e-3fb2-24ca-f73fb00194f1",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "private",
"minimum_start_date": "1901-03-16T05:07:42.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "e1d74e8a-3dc4-d557-6cc0-3af3d9f69d85",
"membership_type_id": "f15342c0-76ed-2791-8499-b956a012c021",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"minim enim",
"occaecat voluptate reprehenderit ullamco elit",
"adipisicing amet velit proident do"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1921-03-30T22:44:50.0Z",
"updated_at": "1965-03-04T01:45:01.0Z"
},
{
"id": "8d8a02da-7613-89e1-ae7d-25d3f478c4dc",
"membership_type_id": "f5dd13fd-a09f-89a0-7839-79d205cbfc73",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ea",
"deserunt",
"deserunt irure Duis et elit",
"minim sit commodo"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1942-01-22T15:09:39.0Z",
"updated_at": "1909-07-27T15:18:36.0Z"
},
{
"id": "48d6a729-4e44-a8e3-4777-5128906b744b",
"membership_type_id": "1e5a1810-11ba-847c-4f83-b26efc7bd010",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"nulla nostrud esse non reprehenderit",
"exercitation aliquip nisi proident culpa",
"do dolore nulla"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1947-02-02T20:31:53.0Z",
"updated_at": "1926-12-15T03:34:15.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1963-01-10T01:42:01.0Z",
"updated_at": "1953-03-13T07:13:31.0Z",
"deleted_at": "1943-12-06T02:16:28.0Z"
},
"payment_details_url": "cillum sint",
"created_at": "1899-03-19T09:35:13.0Z"
},
{
"id": "c2338410-0efb-b598-fd9a-f4b8bdf61f23",
"attention_reason": "payment_failed",
"basket_id": "69d7b6c50d3c32014a000618",
"customer": {
"id": "5aaf68be-e7c7-30c2-bd5a-3cb403e9a1ae",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1946-12-01",
"brand_id": "0a670dc5-7e0a-e95f-7073-7fd3fe5ce088",
"site_id": "63b486c2-db2b-076b-bd2e-ba92a2ee2520",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "9bc13351-64bf-8dad-c712-dae4336477e7",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "62a0d90a-6a48-1fd8-9419-eba124eb5f31",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1933-09-04T16:19:37.0Z",
"created_at": "1933-02-06T02:37:47.0Z",
"updated_at": "1935-01-30T02:50:01.0Z",
"deleted_at": "1891-10-12T10:07:58.0Z",
"last_active_at": "1924-12-28T20:01:32.0Z",
"email_verified_at": "1960-03-29T01:28:21.0Z",
"last_check_in": {
"checked_in_at": "1937-03-07T04:29:03.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "b64d61e1-895f-1e4f-8607-5f38cb9f2008",
"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": "ullamco"
},
"end_date": "1927-07-31T07:29:16.0Z",
"external_ref": "in laboris eiusmod cupidatat incididunt",
"members": [
{
"customer_id": "9e3ae996-b9de-425b-2222-ea784eafc4a6",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "dbeeaf7b-a156-6169-9be2-cd88e7f1a25a",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "9ca07eff-32ec-52a0-c7e4-6e80383094bd",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "0fce463e-ceef-0654-fb3f-15c8a024981a",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1944-08-18T05:17:44.0Z",
"next_charge": {
"id": "6213b078-9337-bb78-dba5-f01571cb3cf4",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1951-02-15",
"billing_period_to": "1918-04-21"
},
"payment_method": {
"id": "esse cillum dolore",
"type": "direct_debit"
},
"rate": {
"id": "30742935-c6f3-21af-2623-55b52d7632be",
"membership_type_id": "9ba2aad8-cc9e-4839-bcce-ce85bd5b7adc",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1950-01-03T02:50:21.0Z",
"updated_at": "1924-09-29T20:02:18.0Z"
},
"site_id": "fd501f6c-8e14-5e63-73cf-5c48866ae520",
"source": "unknown",
"start_date": "1937-07-04T03:04:19.0Z",
"status": "upcoming",
"status_updated_at": "1964-10-12T21:22:20.0Z",
"type": {
"id": "70b5ef1a-8e34-3bd8-620c-eff3630d66c3",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "labore exercitation cillum pariatur",
"brand_id": "7ca5496c-db4c-978c-fd82-77d85b730fe4",
"offline_payments": false,
"disable_confirmation_email": false,
"private": true,
"visibility": "private",
"minimum_start_date": "1902-11-13T10:01:47.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "927ccbb5-6147-53a5-f907-669369a14274",
"membership_type_id": "7141a531-23d1-4f01-00dc-4536c85b2dea",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laborum",
"magna enim nisi minim labore",
"Ut labore laboris magna",
"nostrud cillum aute id"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1890-05-23T04:02:01.0Z",
"updated_at": "1954-08-26T08:28:04.0Z"
},
{
"id": "aaa59d6a-7a17-3eb7-0218-0b52d32b6b6c",
"membership_type_id": "08f05c5c-b67e-cdd1-4d0f-46cff4133ca8",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1914-01-25T06:48:12.0Z",
"updated_at": "1898-12-29T01:49:46.0Z"
},
{
"id": "848e4852-f1ce-847c-b80f-4b668781e2fa",
"membership_type_id": "5d14dfae-9604-d618-8eb5-146ea93c3ff0",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"qui aute est cillum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1918-01-10T01:32:03.0Z",
"updated_at": "1925-10-05T07:23:52.0Z"
},
{
"id": "845e7239-3274-e57a-af97-23b50e61dc1c",
"membership_type_id": "641609c1-7510-a514-2033-28116ef6bd33",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut veniam nulla ullamco",
"et veniam sed aliqua consectetur",
"consequat elit mollit aliqua",
"incididunt consectetur est tempor in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1950-12-19T08:43:31.0Z",
"updated_at": "1941-11-23T11:55:50.0Z"
},
{
"id": "60243d26-6f23-9415-bcbe-52accd04bafc",
"membership_type_id": "377cf727-4984-da0e-407c-e8cd2c50f596",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1930-04-22T02:43:17.0Z",
"updated_at": "1923-08-21T01:01:25.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1925-12-11T01:49:01.0Z",
"updated_at": "1893-07-05T20:32:53.0Z",
"deleted_at": "1950-10-20T16:38:31.0Z"
},
"created_at": "1936-03-19T22:07:45.0Z"
},
{
"id": "050ba9ce-1ab0-fcaf-35e1-ae0061326e16",
"attention_reason": "payment_outstanding",
"basket_id": "69d7b6c50d3c32014a000619",
"customer": {
"id": "83dfbcaa-854c-1c06-e6e3-cb5bbec1a458",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1911-01-30",
"brand_id": "e0e52e1e-0932-3759-7fa4-a9960c0142e3",
"site_id": "95b0bcd8-87f0-49d2-4b35-9110f3fb41a8",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "9b3e4f11-f76c-4d7f-83cb-d693f7668808",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "df6ba737-625a-0fb9-7116-89577f95d449",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "f4241579-1823-22bf-7001-f3820253e7bc",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "f0970ab2-db60-9468-5c72-09fcc9e3abb7",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1923-05-26T09:38:47.0Z",
"created_at": "1912-11-04T07:54:55.0Z",
"updated_at": "1899-02-09T05:27:14.0Z",
"deleted_at": "1899-04-07T09:49:12.0Z",
"last_active_at": "1896-10-26T17:41:48.0Z",
"email_verified_at": "1967-05-12T11:34:45.0Z",
"last_check_in": {
"checked_in_at": "1915-02-09T16:29:01.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "ac50055d-c023-2516-89f6-b5d89a2fa4d5",
"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": "ipsum do laborum"
},
"end_date": "1930-11-29T12:33:32.0Z",
"external_ref": "dolore consectetur",
"members": [
{
"customer_id": "51bd6bca-bf49-12e0-2d17-bd7e5031c6cf",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "bf8be9cc-35be-899e-380a-35b41548ebc6",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "3fc48a21-54e5-b351-b8ee-689d540d9e12",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "3097be12-9ce8-a6b1-b8ea-4edb47666631",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "330f417a-2b59-e87e-734b-526e40a8c2f2",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1897-10-17T08:02:50.0Z",
"next_charge": {
"id": "c295c2c4-28a7-9750-9630-95af5c84665f",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1932-04-17",
"billing_period_to": "1912-11-12"
},
"payment_method": {
"id": "cillum dolore Duis tempor sed",
"status": "revoked"
},
"rate": {
"id": "83ab3bf2-f102-fc6f-8359-d7698a3c9066",
"membership_type_id": "dab3f082-5166-c7f0-54a1-7b96bf8f2d1f",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"tempor aliqua irure et velit",
"in voluptate eu",
"ipsum voluptate reprehenderit",
"quis aute Duis sint enim"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1949-10-04T20:38:38.0Z",
"updated_at": "1921-02-06T17:52:51.0Z"
},
"site_id": "9ca5fb6d-15f1-cc28-6249-ef68bca5ee0c",
"source": "self_signup",
"start_date": "1899-07-15T02:24:22.0Z",
"status": "expired",
"status_updated_at": "1928-01-10T09:35:07.0Z",
"type": {
"id": "41f2d98e-958b-4152-9c64-523b8ecc6064",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "proident dolore incididunt",
"brand_id": "778b5ed0-1d7b-193d-b570-88fa0d5484dc",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "private",
"minimum_start_date": "1917-08-16T20:27:25.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "f5b8670b-9b27-8106-1020-6a187bbcfe74",
"membership_type_id": "435a6b29-fe66-33e4-6c8e-0e0d1e08a0c0",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laborum occaecat consectetur"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1909-06-07T02:40:28.0Z",
"updated_at": "1896-04-24T22:57:05.0Z"
},
{
"id": "20f979af-6e94-0113-37e8-07789c597709",
"membership_type_id": "5e49bc81-9d5d-ce8c-6d1f-122828582195",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"voluptate in aute",
"reprehenderit voluptate aliqua mollit proident",
"tempor nulla dolore anim cillum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1941-03-28T19:03:26.0Z",
"updated_at": "1930-04-17T22:43:18.0Z"
},
{
"id": "d174577b-708c-0b43-c3c6-3bc319685b66",
"membership_type_id": "0edbe844-1eb8-4d4a-44e9-c11facc710b1",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"eiusmod veniam proident",
"magna est id",
"amet aliquip sit qui velit",
"aliquip in do in Excepteur",
"adipisicing labore minim ex quis"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1899-09-19T03:19:04.0Z",
"updated_at": "1965-08-06T06:06:14.0Z"
},
{
"id": "f6264ed3-46e8-71ae-67aa-6129ad7452c6",
"membership_type_id": "17448711-43cd-d281-303b-452c953a68f7",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laboris commodo et nulla",
"in non et",
"mollit",
"id sit",
"reprehenderit aliqua do"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1910-09-01T18:35:10.0Z",
"updated_at": "1930-04-07T01:40:35.0Z"
},
{
"id": "2bb7bb68-9c98-8903-1a33-ab54677213d4",
"membership_type_id": "40bde85f-ae1d-f1bc-c417-90d283162ef3",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"officia"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-03-30T08:28:19.0Z",
"updated_at": "1901-03-15T21:23:06.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1900-08-30T17:53:50.0Z",
"updated_at": "1946-11-07T11:01:43.0Z",
"deleted_at": "1947-06-09T05:27:23.0Z"
},
"payment_details_url": "labore",
"created_at": "1918-09-17T12:44:43.0Z"
},
{
"id": "270c5e76-cbaa-e301-fe63-d7cd54d58b99",
"attention_reason": "mandate_revoked",
"basket_id": "69d7b6c50d3c32014a00061a",
"customer": {
"id": "74a979b2-e811-a4db-4ccd-c37428cad1cb",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1956-07-14",
"brand_id": "40e3bf03-dc7d-6cd2-7cac-b8baf4e6a4de",
"site_id": "c524fe96-f92c-e8ec-a343-6bf0cdbf7156",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1892-12-04T09:57:36.0Z",
"created_at": "1908-01-14T17:32:42.0Z",
"updated_at": "1913-08-13T05:56:05.0Z",
"deleted_at": "1933-02-26T02:03:44.0Z",
"last_active_at": "1953-10-18T18:33:29.0Z",
"email_verified_at": "1903-08-31T06:11:05.0Z",
"last_check_in": {
"checked_in_at": "1902-01-24T12:38:29.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "e2686166-cb40-0ff5-1cf5-540462fb9791",
"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 esse tempor ad"
},
"end_date": "1955-03-19T05:08:38.0Z",
"external_ref": "elit Lorem in sed",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1948-08-26T23:39:22.0Z",
"next_charge": {
"id": "e7586026-dd38-6675-142f-43e0eb095976",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1925-03-04",
"billing_period_to": "1923-09-03"
},
"payment_method": {
"id": "ut Duis",
"type": "direct_debit"
},
"rate": {
"id": "47dcf318-756d-94c0-93e2-b8229e29e26e",
"membership_type_id": "59b7a606-b1d0-8d95-c198-d07794b03bb4",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Duis enim",
"laborum Excepteur qui sed"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1935-09-23T23:09:53.0Z",
"updated_at": "1949-05-29T09:41:48.0Z"
},
"site_id": "065f7fd7-a8f8-431f-38ef-76bf8dab5c22",
"source": "app",
"start_date": "1946-09-13T01:44:17.0Z",
"status": "active",
"status_updated_at": "1899-08-25T11:57:37.0Z",
"type": {
"id": "fade08eb-d51a-0cd7-2774-722c750a0b32",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "laborum nisi",
"brand_id": "e60dad50-ae87-aa78-f6ee-3b6549a47cdc",
"offline_payments": false,
"disable_confirmation_email": false,
"private": false,
"visibility": "public",
"minimum_start_date": "1893-01-23T09:24:41.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1953-04-10T10:56:35.0Z",
"updated_at": "1957-06-18T10:01:20.0Z",
"deleted_at": "1957-09-23T01:22:21.0Z"
},
"payment_details_url": "ipsum in",
"created_at": "1957-05-21T13:04:43.0Z"
},
{
"id": "05e96b46-fe86-f586-2f5b-da1f5ea80f7e",
"attention_reason": "setup_unpaid",
"basket_id": "69d7b6c50d3c32014a00061b",
"customer": {
"id": "70b7c6a7-e112-4b3d-c6cb-0d09124e7ee8",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1915-02-14",
"brand_id": "3919820f-ffd0-3c5c-f9bd-4815f17fd45a",
"site_id": "ef3692db-7879-ed4a-566c-664d419e3a6f",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1902-02-28T10:40:53.0Z",
"created_at": "1939-06-15T11:43:08.0Z",
"updated_at": "1944-06-09T22:02:48.0Z",
"deleted_at": "1917-02-09T14:53:31.0Z",
"last_active_at": "1896-12-04T23:01:35.0Z",
"email_verified_at": "1959-07-16T20:06:01.0Z",
"last_check_in": {
"checked_in_at": "1905-05-16T14:51:50.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "8329c001-bb8d-5269-0312-ba69d0054be9",
"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": "officia Ut elit sit"
},
"end_date": "1954-09-20T05:20:25.0Z",
"external_ref": "proident est irure",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1927-05-29T21:56:41.0Z",
"next_charge": {
"id": "21c47d1b-8738-e41f-3cdf-0a3a74882055",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1958-02-06",
"billing_period_to": "1911-03-22"
},
"payment_method": {
"id": "velit Lorem tempor aliqua",
"type": "card",
"last_4": "occaecat labore id anim tempor",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "40ae0e07-d808-ada9-416c-60a7df776400",
"membership_type_id": "e5ca6c42-3131-1f1f-f8b1-355705874398",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laboris ut veniam consectetur in",
"amet ullamco consectetur et sit",
"ea",
"laborum",
"mollit laboris ut magna nulla"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1969-08-14T01:12:40.0Z",
"updated_at": "1969-02-26T09:46:06.0Z"
},
"site_id": "0038afd8-efc4-7b7b-4c7c-207ccd21aba9",
"source": "self_signup",
"start_date": "1916-10-06T01:31:46.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1928-01-12T01:04:17.0Z",
"type": {
"id": "c6559935-23f1-23a4-159c-e3a9e0a83617",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "esse non",
"brand_id": "12b6622e-ffa6-c283-7aa3-fcefd41221d4",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "public",
"minimum_start_date": "1929-11-29T07:07:55.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1928-05-04T21:08:01.0Z",
"updated_at": "1938-05-20T20:39:39.0Z",
"deleted_at": "1941-08-02T22:08:46.0Z"
},
"payment_details_url": "ullamco sed officia enim cupidatat",
"created_at": "1944-01-25T14:16:07.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": "cb503775-21b2-b5cc-2e26-be1c1121409a",
"attention_reason": "setup_unpaid",
"basket_id": "69d7b6c50d3c32014a00061c",
"customer": {
"id": "28bab4a4-414c-db47-e2b7-50ba30800603",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1965-09-17",
"brand_id": "1a04dfe5-b301-52a1-5fa6-7e07e0e4b343",
"site_id": "07ac1c5c-9c20-f81a-8a04-63f1de6ae675",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "cf79b90c-7b79-a461-92b0-2bea3cbf3858",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "19e00ffb-514e-b703-9584-4406f682bb9b",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1944-05-04T05:52:12.0Z",
"created_at": "1964-02-18T18:38:44.0Z",
"updated_at": "1942-03-19T15:08:54.0Z",
"deleted_at": "1963-05-29T18:08:58.0Z",
"last_active_at": "1935-06-27T18:57:02.0Z",
"email_verified_at": "1904-12-20T04:58:49.0Z",
"last_check_in": {
"checked_in_at": "1949-05-02T18:41:41.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "ccfc8807-1d61-9847-a403-d91a342464e0",
"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": "adipisicing eu"
},
"end_date": "1951-08-04T08:43:39.0Z",
"external_ref": "elit",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1923-10-16T09:55:55.0Z",
"next_charge": {
"id": "46d4329b-9b90-74a0-2218-8f4861e72fd2",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1891-04-07",
"billing_period_to": "1931-02-27"
},
"payment_method": {
"id": "ipsum officia ea incididunt adipisicing",
"type": "card",
"last_4": "minim et ea incididunt ullamco",
"card_brand": "amex"
},
"rate": {
"id": "c2266613-b645-dbee-e38c-1935ac6010c6",
"membership_type_id": "5c876824-3e5e-be5c-139c-be6be051d2cd",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"in officia veniam ex",
"enim culpa et sit consectetur",
"veniam amet"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1900-10-02T08:06:33.0Z",
"updated_at": "1906-10-28T15:31:40.0Z"
},
"site_id": "ff3c5487-0a56-f91f-8148-005a4d18e991",
"source": "app",
"start_date": "1929-08-03T10:15:59.0Z",
"status": "inactive",
"status_updated_at": "1913-07-07T05:11:44.0Z",
"type": {
"id": "5dc0f18e-a84b-38d4-d7dc-a4994bafbdb7",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "deserunt",
"brand_id": "31955a7c-aff7-d52b-2953-bc5a3170a653",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "private",
"minimum_start_date": "1922-03-15T03:25:49.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "fa923684-5330-2081-7cb1-48ab08bcda9f",
"membership_type_id": "30b1e725-703a-5128-93fd-9ee891a15048",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Duis",
"minim cillum",
"proident enim mollit cupidatat",
"id"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1930-09-25T09:11:21.0Z",
"updated_at": "1928-05-19T06:36:13.0Z"
},
{
"id": "a6520683-f7c4-5a6c-12a5-82919d1a2a74",
"membership_type_id": "9e58d948-d418-07d3-db25-6d8ffd398b5f",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1902-04-16T13:52:02.0Z",
"updated_at": "1947-04-19T23:30:17.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1929-03-04T18:16:05.0Z",
"updated_at": "1966-04-10T10:48:28.0Z",
"deleted_at": "1947-03-14T09:55:34.0Z"
},
"payment_details_url": "quis nostrud dolore ad",
"created_at": "1958-03-18T19:10:14.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": "848d821d-ed27-8d6d-ae24-6d5ca4197a95",
"membership": {
"id": "54af287e-5757-9a13-4e6d-27b8e7c06626",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "6ca74c8d-672d-18ee-bc17-bab9b3223205",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type_id": "69d7b6c60d3c32014a00061f"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "minim",
"can_download_receipt": false,
"amount_refunded": 63266024,
"refunded": true,
"refunds": [
{
"id": "697f3d02-40d3-bae5-75d1-db22dd389bf1",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "9ab17dbc-6a06-3903-61a7-7bee265bd454",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1895-11-30T23:02:30.0Z",
"updated_at": "1930-09-21T16:51:17.0Z"
},
{
"id": "f1ada479-24d9-9e4b-85cc-724d63843562",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "7658d677-7458-c843-e102-36205c43ba94",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1952-07-23T14:48:46.0Z",
"updated_at": "1914-07-07T04:33:53.0Z"
}
],
"site_id": "04f2bfe7-914f-bb45-0e8e-328d32833e32",
"billing_period_from": "1964-05-10",
"billing_period_to": "1891-05-17",
"processing_at": "1952-11-06T01:36:45.0Z",
"created_at": "1964-02-01T11:15:24.0Z",
"updated_at": "1911-07-21T04:58:49.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": "07faf6cb-9b4c-39a3-7b40-447d1eb9d555",
"membership": {
"id": "8f4e69a6-d12c-a088-0e10-e70f67aa0e6c",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "cdef0b4d-a9d7-60b5-0069-4a50e5bf83e7",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "69d7b6c50d3c32014a00061d"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "voluptate ipsum",
"can_download_receipt": true,
"amount_refunded": 94601095,
"refunded": false,
"refunds": [
{
"id": "18df3b29-9c73-15f5-eb57-fc00fc7403bf",
"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": "1945-02-19T02:45:45.0Z",
"updated_at": "1923-08-17T10:16:22.0Z"
},
{
"id": "c529031e-8a30-d661-23f4-91e62f5754fb",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "45c72af3-4597-9f8b-658d-38fa3a4fbedf",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1934-08-15T07:42:24.0Z",
"updated_at": "1908-07-27T16:30:34.0Z"
},
{
"id": "6d43bb19-4cd2-c37f-1dab-77ff429577b8",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "fffd1184-c211-a5e2-fc62-8c4d2ae0bf13",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1952-12-04T15:21:20.0Z",
"updated_at": "1963-07-12T20:28:11.0Z"
}
],
"site_id": "2fbeb86e-2b7c-991c-ae12-433c46f66b1b",
"billing_period_from": "1943-05-07",
"billing_period_to": "1903-04-24",
"processing_at": "1896-08-03T23:50:57.0Z",
"created_at": "1935-07-30T01:33:52.0Z",
"updated_at": "1907-07-25T09:01:41.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": "8d74601a-bae3-0463-e1a4-2a80831be0f2",
"membership": {
"id": "926eac7b-7735-6451-3b8e-05e9a4aa35df",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "836b748c-40b5-267c-3ca0-0d7ee493f65e",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "69d7b6c50d3c32014a00061e"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "eiusmod cillum qui dolore laborum",
"can_download_receipt": true,
"amount_refunded": 87141643,
"refunded": false,
"refunds": [
{
"id": "07234389-ebce-dcf5-7917-6bb02a875d0e",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "6c490b7a-ce8e-3de7-9375-bb77970a4183",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1962-05-15T17:22:22.0Z",
"updated_at": "1942-03-01T01:11:40.0Z"
},
{
"id": "575cee2f-b5e6-072f-03f6-1f24886c10cd",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "15b8a55e-3f0c-9bc2-7f93-320ae0f7a5f1",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1968-12-31T01:40:04.0Z",
"updated_at": "1955-01-22T04:06:49.0Z"
}
],
"site_id": "d4e50d86-f2b0-eeb0-063b-7ddfe7256a2c",
"billing_period_from": "1959-12-30",
"billing_period_to": "1922-03-21",
"processing_at": "1949-09-22T14:10:31.0Z",
"created_at": "1944-03-04T20:10:15.0Z",
"updated_at": "1954-10-03T14:54:02.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": "69d7b6c60d3c32014a000620",
"organisation_id": "a1d1f25b-b970-884d-fd37-afb2673036e7",
"site_id": "12b22921-399d-ed0f-70b1-de68e6a9d5f3",
"customer_id": "9b451219-c7e5-343f-5968-98f3a0bb62ae",
"membership_id": "dc0d9273-1d61-a766-6ff3-3a17b13555a4",
"from": "Trybe",
"to": "+447123456789",
"message": "magna ad reprehenderit dolor consequat",
"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": {
"fugiat_d": [
"minim laboris cillum sint"
]
},
"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": "71e90b85-c97b-ce72-e1a1-5ce28358adee",
"organisation_id": "73e47dc3-69fb-ffe7-1c22-d0073fbf44fc"
}
}{
"message": "The requested resource could not be found"
}