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": "b86bb72e-3028-c8bf-eb67-01bf3ea0e8a6",
"attention_reason": "mandate_revoked",
"basket_id": "69eb6f540c43fe014a0000b3",
"customer": {
"id": "e1369f6b-55e0-a3dc-5c32-cc85b9ad50df",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1950-06-03",
"brand_id": "4994bcc3-9434-f632-34ae-9ba3f54629e0",
"site_id": "31992be3-5fdb-c3aa-bcc2-30bcea8e8e82",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1911-06-07T07:17:23.0Z",
"created_at": "1904-08-26T04:37:31.0Z",
"updated_at": "1946-02-08T18:48:48.0Z",
"deleted_at": "1935-02-04T08:51:27.0Z",
"last_active_at": "1908-03-15T03:03:33.0Z",
"email_verified_at": "1957-10-27T20:09:59.0Z",
"last_check_in": {
"checked_in_at": "1905-03-02T20:58:56.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "500faded-9cd9-546c-d8db-feebe99813e3",
"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": "eu proident exercitation"
},
"end_date": "1933-01-20T05:46:01.0Z",
"external_ref": "sint Excepteur Lorem",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1920-01-12T12:59:46.0Z",
"next_charge": {
"id": "ffccfabb-2c57-2ce4-4940-81f4f2aa911d",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1956-04-10",
"billing_period_to": "1916-06-22"
},
"payment_method": {
"id": "ut sunt laboris fugiat",
"type": "card",
"last_4": "minim",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "59025f4c-335e-feed-f8b0-12f8a4fb3fa7",
"membership_type_id": "0f3f38b3-b66f-a5d6-13be-53c20f775e6b",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut culpa ullamco amet sed"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1941-05-13T10:26:22.0Z",
"updated_at": "1949-03-13T01:23:58.0Z"
},
"site_id": "8b540056-7c87-6515-47f2-91d1a9cc617e",
"source": "self_signup",
"start_date": "1915-06-29T01:06:05.0Z",
"status": "upcoming",
"status_updated_at": "1913-01-27T01:05:45.0Z",
"type": {
"id": "03a67782-db22-b31c-0b41-449e88e73312",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "laboris qui",
"brand_id": "ce073b34-e4e1-8e43-3cf3-6c7d42f43590",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "public",
"minimum_start_date": "1919-04-15T17:24:03.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "6ac4effc-7efa-a358-6ada-9a3b7211352c",
"membership_type_id": "089c52fe-0a95-27b9-7e27-5ec6083c56d6",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"sunt dolor nisi ipsum consequat",
"voluptate reprehenderit eiusmod",
"occaecat dolore eu cupidatat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1932-04-30T15:20:38.0Z",
"updated_at": "1936-03-08T17:11:09.0Z"
},
{
"id": "785783ab-2e04-845b-3973-77647ebf131a",
"membership_type_id": "54295927-c162-7a51-3edd-d14951a8f973",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"magna laborum aliquip et Duis",
"voluptate"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1907-04-19T04:30:39.0Z",
"updated_at": "1942-11-28T22:52:11.0Z"
},
{
"id": "e496f698-e3d7-393f-d609-6bf34c05f200",
"membership_type_id": "0b3481e5-dadc-64c5-ce98-21122009ff37",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aliqua",
"amet ex ut labore do",
"do nostrud fugiat aliquip",
"quis consectetur aute"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1918-08-24T22:35:26.0Z",
"updated_at": "1939-10-23T13:32:11.0Z"
},
{
"id": "ded25329-7625-f59e-a3ee-df87f2358443",
"membership_type_id": "4f0a6815-95e2-e433-ed5c-f42602d8db99",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"mollit veniam anim qui",
"labore"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1892-01-14T01:47:07.0Z",
"updated_at": "1899-11-13T15:42:44.0Z"
},
{
"id": "bdea9440-3016-5ce5-27e5-2badc8fa4730",
"membership_type_id": "fb244e35-196e-595a-7c16-6aab6f0de580",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"cillum amet labore cupidatat",
"sunt"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1921-10-02T04:23:11.0Z",
"updated_at": "1938-12-22T01:10:34.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1895-04-27T12:26:21.0Z",
"updated_at": "1965-09-14T19:39:17.0Z",
"deleted_at": "1899-01-12T03:52:31.0Z"
},
"payment_details_url": "veniam",
"created_at": "1965-05-04T22:05:25.0Z"
},
{
"id": "1915198f-5e65-43ff-826f-69454e6b9250",
"attention_reason": "mandate_revoked",
"basket_id": "69eb6f540c43fe014a0000b4",
"customer": {
"id": "df865b12-75cf-f548-13ea-3ae04f80b863",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1924-02-12",
"brand_id": "bec76d9a-016c-f154-aada-f993e4411ec9",
"site_id": "def347b7-ee2e-250a-c152-07232ac2fb51",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "16b0c11e-b42d-f3e9-de6c-49adf6d675bd",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "24fbdfc5-ee3a-e671-ac2f-e3a2688ef450",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "f6b96b49-0333-aa1f-7de3-b982424fdc00",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "9e21ccb1-d923-887d-0686-12e4c0c48d0e",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "26a6e451-4e40-94b1-3a32-213d12e89704",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1908-08-27T19:23:46.0Z",
"created_at": "1890-10-26T21:20:02.0Z",
"updated_at": "1905-01-14T15:18:45.0Z",
"deleted_at": "1922-03-28T23:03:45.0Z",
"last_active_at": "1926-07-26T18:49:16.0Z",
"email_verified_at": "1961-09-05T02:24:08.0Z",
"last_check_in": {
"checked_in_at": "1891-10-04T05:02:46.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "54f73492-13c3-f2b4-a765-5fbefb80be94",
"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": "Ut tempor Lorem labore"
},
"end_date": "1905-04-06T11:03:25.0Z",
"external_ref": "nisi",
"members": [
{
"customer_id": "0d206cf7-d3f0-0b8f-a4ad-882eb085157e",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "ce1b1c9b-df09-aa40-60ff-5b45366ffa2a",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1936-01-15T20:35:54.0Z",
"next_charge": {
"id": "ffa1ef32-561e-dd83-8c58-022a6598e775",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1920-03-09",
"billing_period_to": "1968-08-11"
},
"payment_method": {
"id": "enim laboris ipsum",
"type": "direct_debit",
"card_brand": "amex"
},
"rate": {
"id": "10afec9a-d9ff-5df0-9228-a075f94c7ae0",
"membership_type_id": "ecb67647-8a0d-f282-37c1-7020f7d1ece5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"commodo ex Excepteur",
"esse velit",
"nostrud tempor officia eu fugiat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1893-12-21T06:31:22.0Z",
"updated_at": "1940-01-05T17:06:24.0Z"
},
"site_id": "eb70da86-0b43-922f-f49c-595c93d28445",
"source": "import",
"start_date": "1903-12-14T12:55:43.0Z",
"status": "reserved",
"status_updated_at": "1932-03-03T08:31:25.0Z",
"type": {
"id": "23bcf014-31cb-298a-2633-f8c26490bd98",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "do eiusmod dolor dolor",
"brand_id": "75953987-f7aa-bd32-8783-16210a5ba1d0",
"offline_payments": true,
"disable_confirmation_email": true,
"private": true,
"minimum_start_date": "1937-05-09T10:45:50.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1958-07-27T13:17:47.0Z",
"updated_at": "1902-08-24T05:50:27.0Z",
"deleted_at": "1938-06-07T04:57:43.0Z"
},
"payment_details_url": "non",
"created_at": "1914-11-09T07:11:29.0Z"
},
{
"id": "acdccdf1-f8fb-8451-f938-725af8ab39fb",
"attention_reason": "payment_failed",
"basket_id": "69eb6f540c43fe014a0000b5",
"customer": {
"id": "e1cfef7b-8ebf-f114-8bf7-e196c5a7b4d9",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1900-03-09",
"brand_id": "a90f03d5-9bc0-63a0-19b2-302b6ed4da4b",
"site_id": "a481891a-00f6-5899-ea6a-e6c4cbad9725",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "5aa99dad-e3eb-03ad-1735-045d27211d3d",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "9e8202b5-af15-13f5-0870-2511ce7bd5d1",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1901-05-26T06:27:47.0Z",
"created_at": "1938-07-01T11:04:57.0Z",
"updated_at": "1900-03-12T04:36:43.0Z",
"deleted_at": "1942-11-23T08:38:21.0Z",
"last_active_at": "1928-08-03T12:50:06.0Z",
"email_verified_at": "1890-10-03T10:54:35.0Z",
"last_check_in": {
"checked_in_at": "1958-03-18T07:58:37.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "f05d310c-0520-3863-889b-7cd8e6bd34ef",
"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": "fugiat aliquip"
},
"end_date": "1919-12-15T06:24:31.0Z",
"external_ref": "voluptate aliqua fugiat consequat laborum",
"members": [
{
"customer_id": "1182ad5b-6435-5a99-b040-f218646ae539",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "889b5dd6-ee3c-c8cd-a32c-4256206b610b",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1926-03-27T16:14:55.0Z",
"next_charge": {
"id": "a5d40bcf-64a0-aed5-c089-dbc1e886ce39",
"amount": 3995,
"currency": "GBP",
"status": "processing",
"billing_period_from": "1891-11-20",
"billing_period_to": "1927-07-12"
},
"payment_method": {
"id": "officia",
"last_4": "magna labore veniam dolor dolore",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "457477e0-6e9b-b21e-20e6-4db142ae38e9",
"membership_type_id": "c8db93ec-2280-38b5-8a8d-0ff0e41737a6",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolor officia adipisicing ut",
"nisi Duis do veniam ea",
"ad",
"consequat adipisicing minim"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1958-02-15T10:17:34.0Z",
"updated_at": "1922-05-23T15:14:53.0Z"
},
"site_id": "a4ed6740-d64e-38d0-0ec6-c53f4f00cd54",
"source": "import",
"start_date": "1941-01-22T01:50:33.0Z",
"status": "expired",
"status_updated_at": "1918-05-19T08:35:33.0Z",
"type": {
"id": "52bc5009-a28b-0f1a-a45b-d5ef6d36b1e7",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "adipisicing enim cupidatat dolor laborum",
"brand_id": "d81f2b82-3aa5-f48b-153c-7128505590c2",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1927-06-07T15:52:27.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "39134aba-3a04-16c9-ff51-3a8984e24f2a",
"membership_type_id": "1a81bd8a-b26c-3c5c-5ae9-f03cee74be9f",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"in eu voluptate consectetur",
"irure",
"aliquip",
"reprehenderit nisi et ad"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1954-05-06T20:07:47.0Z",
"updated_at": "1906-10-09T23:03:31.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1950-08-12T23:11:23.0Z",
"updated_at": "1896-12-18T14:12:45.0Z",
"deleted_at": "1905-11-12T15:50:37.0Z"
},
"payment_details_url": "velit",
"created_at": "1916-03-25T17:46:43.0Z"
},
{
"id": "ec9c239c-d392-8dfc-2396-48f30a588067",
"attention_reason": "mandate_revoked",
"basket_id": "69eb6f540c43fe014a0000b6",
"customer": {
"id": "4857bbb8-2808-aff1-8d82-4b92c06f48e9",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1952-08-09",
"brand_id": "c4279acb-0c84-4b14-555d-6db17a25b222",
"site_id": "feae528a-4824-3561-ed54-cab371506a25",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "cb7c0d99-637f-72ee-56da-22bfd9d701f6",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "920a4933-c47f-3824-7947-546a8fb5a2e5",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "69879c4e-f884-51b7-1482-d7ece3a20ce4",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1919-05-20T22:27:12.0Z",
"created_at": "1966-03-10T18:26:12.0Z",
"updated_at": "1948-07-17T23:55:06.0Z",
"deleted_at": "1923-06-04T19:59:18.0Z",
"last_active_at": "1944-05-07T01:09:44.0Z",
"email_verified_at": "1940-09-13T08:43:14.0Z",
"last_check_in": {
"checked_in_at": "1961-01-14T21:16:20.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "01bf6e4b-f41d-e2e6-e5c5-cb514de3fd40",
"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": "irure et tempor nulla"
},
"end_date": "1924-04-23T05:48:48.0Z",
"external_ref": "dolore sit",
"members": [
{
"customer_id": "813bb1f0-2007-178e-2469-e270fc947774",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "74522165-145a-2870-506a-e8214fe432ad",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "2c161b7e-e794-8c55-8209-b4c116577d67",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "61d25357-7959-d241-6cdb-44eb5e2f8e37",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1938-01-31T01:51:29.0Z",
"next_charge": {
"id": "d52c7006-e5f0-484d-ad38-8abb63ec40f9",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1910-09-30",
"billing_period_to": "1944-03-18"
},
"payment_method": {
"id": "qui dolore",
"type": "direct_debit",
"last_4": "adipisicing",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "5225dd2a-0d30-cc85-21a2-689c82ffa28f",
"membership_type_id": "83324631-ada7-72c8-12eb-acc3cff522c4",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"est reprehenderit labore ipsum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1922-12-01T07:43:34.0Z",
"updated_at": "1953-04-05T19:10:23.0Z"
},
"site_id": "f56d48ec-7864-971c-b1ca-5cf3fedaf888",
"source": "self_signup",
"start_date": "1906-02-09T22:33:20.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1934-08-12T01:41:45.0Z",
"type": {
"id": "c0e82e7d-3614-a122-c856-e6a1064eb687",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "enim sed incididunt voluptate",
"brand_id": "8a9662bd-5974-b60b-fcfa-9b0a10d323f1",
"offline_payments": false,
"disable_confirmation_email": true,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1926-09-10T04:41:14.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "6750f267-1ac8-8105-f42d-25856cb9ebb0",
"membership_type_id": "7547e017-e8a5-fd67-4171-bc338541c74e",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"amet esse id exercitation ipsum",
"adipisicing pariatur in laborum",
"magna ut"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1933-09-07T04:06:18.0Z",
"updated_at": "1891-08-13T17:37:49.0Z"
},
{
"id": "ebeb5b2c-8a35-a774-2db1-2e98b70816b3",
"membership_type_id": "00516c76-11f8-53ba-eb5c-2f046bdd41bd",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolor aliquip",
"ipsum in ad pariatur in",
"laboris consectetur dolor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1918-05-17T06:02:05.0Z",
"updated_at": "1896-07-28T20:38:43.0Z"
},
{
"id": "a1f1ffd9-4ce6-582e-de90-4de218a1b4d4",
"membership_type_id": "0072e6ec-4ace-ce56-f93b-df6812ddc88a",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aute adipisicing Excepteur"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1966-12-24T10:44:35.0Z",
"updated_at": "1966-10-04T23:41:35.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1936-11-11T12:26:59.0Z",
"updated_at": "1919-01-19T01:30:43.0Z",
"deleted_at": "1963-07-29T11:49:32.0Z"
},
"payment_details_url": "dolor reprehenderit et ut aute",
"created_at": "1908-03-16T06:17:18.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": "1e806dd4-e0e0-794a-8b7d-7c6226044576",
"attention_reason": "mandate_revoked",
"basket_id": "69eb6f540c43fe014a0000b7",
"customer": {
"id": "3ee516c6-68f5-89ae-3ad2-cafdc0273360",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1921-04-15",
"brand_id": "8dd5abed-cc81-dec8-dc74-334d124a7652",
"site_id": "e1afe548-acde-dad4-27c0-d8831c47d976",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "c3f0fbce-f1bf-9809-3072-d70f8a77f974",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "8db094be-e5cc-5643-53dd-7daaa5b8cdc1",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "88a199d5-938c-f0e4-4843-07df1147a50c",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1902-05-22T10:41:02.0Z",
"created_at": "1947-06-04T03:01:09.0Z",
"updated_at": "1949-11-03T09:52:44.0Z",
"deleted_at": "1934-10-23T04:36:57.0Z",
"last_active_at": "1932-09-02T20:15:43.0Z",
"email_verified_at": "1958-03-06T11:40:32.0Z",
"last_check_in": {
"checked_in_at": "1959-11-15T04:56:16.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "e0c037e9-6554-d3a7-332f-7b9adb3ccb41",
"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": "sit"
},
"end_date": "1936-09-18T17:09:28.0Z",
"external_ref": "magna deserunt ad cillum in",
"members": [
{
"customer_id": "c52fc695-71b0-fd81-24ec-6e02b4f15128",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "c7078748-8edb-399b-5788-ab804b59cf48",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "0a7ff5a5-1990-a7ce-b978-bd8fd94b896f",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1919-05-20T19:32:19.0Z",
"next_charge": {
"id": "bce5e160-39f6-3160-f9fe-2f18a69aaae4",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1922-06-09",
"billing_period_to": "1947-02-22"
},
"payment_method": {
"id": "dolor velit sit ad",
"type": "card",
"last_4": "dolor commodo reprehenderit",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "64ef41d9-5f75-2d38-bcc3-86d0ae4cb447",
"membership_type_id": "2bfd6800-52fa-d2a0-bbf6-f2ddb5fc025d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aliqua est",
"exercitation pariatur et do sed",
"Lorem reprehenderit",
"eu anim voluptate",
"ut"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1940-11-29T06:03:09.0Z",
"updated_at": "1939-08-28T19:07:22.0Z"
},
"site_id": "dd324bec-13a7-16d9-42a7-0b2834f91b99",
"source": "unknown",
"start_date": "1927-05-17T03:26:15.0Z",
"status": "active",
"status_updated_at": "1923-10-25T06:10:42.0Z",
"type": {
"id": "d6e29559-6396-5590-db8a-109379160bfe",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "ut dolore id in",
"brand_id": "b41c5fae-1129-0c62-0e0d-7a0ada4bdf54",
"offline_payments": true,
"disable_confirmation_email": true,
"private": true,
"visibility": "private",
"minimum_start_date": "1917-03-31T17:16:54.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "1e949a84-5717-00d0-0b80-e056ff91c248",
"membership_type_id": "2bb021f7-a363-72aa-67eb-2bf938687059",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laborum magna",
"aliquip enim exercitation ut sit",
"sit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1901-05-25T02:14:34.0Z",
"updated_at": "1950-10-04T18:06:07.0Z"
},
{
"id": "7a57d4ce-2e19-3dfe-20a9-2549fdd91b4f",
"membership_type_id": "30380c0d-d082-1dbd-765a-caf931b33961",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"sed id voluptate non tempor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1899-08-26T12:08:24.0Z",
"updated_at": "1891-07-02T01:31:51.0Z"
},
{
"id": "b6782dd2-6ab0-ad92-ef9c-48d4b1e51fe4",
"membership_type_id": "a8132577-212c-42f4-be32-8753ca49c0d5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1966-04-07T22:59:28.0Z",
"updated_at": "1893-04-21T01:24:57.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1891-07-22T15:22:57.0Z",
"updated_at": "1908-08-31T16:15:14.0Z",
"deleted_at": "1931-04-06T19:03:02.0Z"
},
"payment_details_url": "in sunt nulla culpa anim",
"created_at": "1968-09-08T12:11:03.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": "274520b2-cedf-78d0-5c44-51fc446b67fe",
"membership": {
"id": "b0b0c4c9-aa9a-ed54-8bbd-c8716902cac1",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "c7db562a-eee3-2f1a-2d88-03495175f087"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "Duis proident ea dolore id",
"can_download_receipt": false,
"amount_refunded": 51423669,
"refunded": true,
"refunds": [
{
"id": "9909d025-bfcb-510a-f1aa-123d346e3852",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "575e6c1d-43d5-c741-b3cd-a90fd5f39541",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1928-05-01T07:04:43.0Z",
"updated_at": "1895-09-08T12:52:32.0Z"
},
{
"id": "1de3d37d-0bae-30f4-6685-778af02d853c",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "e4298ed5-8490-f324-defc-92b417289ec8",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1900-04-14T05:51:49.0Z",
"updated_at": "1965-05-20T04:19:53.0Z"
},
{
"id": "3108bd76-a094-3059-f0a5-9c2e3065e928",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "abc98f72-1cfa-dc28-8f0b-54d788df2c6e",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1907-10-24T17:49:56.0Z",
"updated_at": "1919-04-01T16:04:34.0Z"
},
{
"id": "14c2ef97-bad6-b54d-5f8b-207948e4c1e0",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "421dd5a6-596e-c986-ab0a-4a4c9e0772c8",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1946-08-14T06:18:04.0Z",
"updated_at": "1931-09-09T20:47:26.0Z"
}
],
"site_id": "9a7b419d-f885-73ed-2ca6-f16908ddaf24",
"billing_period_from": "1959-04-08",
"billing_period_to": "1952-11-17",
"created_at": "1917-10-26T01:20:52.0Z",
"updated_at": "1909-10-08T17:27:39.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": "e773f4f3-a6ff-f2fc-136d-c27d2fbd1305",
"membership": {
"id": "8ae925b5-f3ad-048b-230d-895042cd3046",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "7ac61159-cde7-dbf3-18d4-6858550af6c2",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "69eb6f540c43fe014a0000b8"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "Excepteur id ullamco nulla dolor",
"can_download_receipt": false,
"amount_refunded": -22925345,
"refunded": false,
"refunds": [
{
"id": "d5857d46-5e73-f756-14c2-a51df558d61f",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "1b4bdc36-8bed-5f13-b3f7-25eee6e391cd",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1938-10-29T18:50:17.0Z",
"updated_at": "1942-10-29T03:42:06.0Z"
},
{
"id": "9397a5ae-a1d3-4274-213f-c27929cd688f",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1891-11-05T06:44:04.0Z",
"updated_at": "1891-05-05T08:54:29.0Z"
},
{
"id": "f3f6df71-ad7b-008b-3670-ae029b6e4521",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "001c92d8-15ce-8c7d-f287-10394d5127a0",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1924-03-01T13:31:45.0Z",
"updated_at": "1898-11-13T12:47:01.0Z"
},
{
"id": "f9279b7c-199b-e268-e95a-4abb27c742bc",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "f92c20b0-299f-eaf3-fd8c-10399dbdf1a3",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1892-09-20T15:56:21.0Z",
"updated_at": "1906-11-30T15:04:19.0Z"
},
{
"id": "a36f7563-b258-f067-f0a1-73ebb54cf597",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "92710d9e-2d9d-25f2-0782-c6212be9594a",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1928-06-20T04:35:26.0Z",
"updated_at": "1941-01-14T11:57:13.0Z"
}
],
"site_id": "e1d601e4-93f6-556e-a2b8-25f7684e5c12",
"billing_period_from": "1922-11-12",
"billing_period_to": "1890-11-12",
"processing_at": "1967-11-09T17:22:17.0Z",
"created_at": "1926-12-01T13:21:16.0Z",
"updated_at": "1907-07-04T06:24:57.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": "9d57d0c9-4077-6176-dea0-14a3441c5e3c",
"membership": {
"id": "c6ded9d6-bfa6-d54e-e286-7bcaf7fcf82d",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "027a8c4d-7fb9-f9e8-4af3-d52b88848db3",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "do Duis",
"can_download_receipt": false,
"amount_refunded": 91997795,
"refunded": true,
"refunds": [],
"site_id": "38d26f81-e619-3f75-1648-d882bc2d08c9",
"billing_period_from": "1938-09-19",
"billing_period_to": "1901-05-14",
"processing_at": "1912-03-05T10:16:31.0Z",
"created_at": "1923-08-18T12:50:46.0Z",
"updated_at": "1894-03-27T18:55:56.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": "69eb6f540c43fe014a0000c8",
"organisation_id": "4e152a11-9da3-db47-3970-6067bc3595f4",
"site_id": "0ce95f67-e4fa-3d77-27e8-7cc7d3710af3",
"customer_id": "73519f95-51f4-b3ff-0f2e-db4a43cc3e44",
"membership_id": "ab218d50-734c-c487-0442-6c7b8c7eb85c",
"from": "Trybe",
"to": "+447123456789",
"message": "amet",
"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": {
"consectetur1": [
"amet laborum anim",
"occaecat Duis eiusmod velit",
"dolor in enim eiusmod",
"minim cupidatat"
]
},
"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": "0ed7d706-63ac-dbe1-f547-87ec0f94729e",
"organisation_id": "5730a6f1-c5bb-59b0-e3fd-09880bb4d56f"
}
}{
"message": "The requested resource could not be found"
}