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": "918e829c-6d07-ba5c-cdc1-f05f6f189104",
"attention_reason": "payment_outstanding",
"basket_id": "69c2bcf0b3abb30148000684",
"customer": {
"id": "5087c61b-3b21-952a-f8b5-f81191567d58",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1962-06-03",
"brand_id": "a4becdf2-ca39-b929-809d-c8eec156bfcc",
"site_id": "c4ccb94b-f9c4-5049-88fa-3259d2410b9d",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "97fa7b0f-48d7-bb15-81ff-5d81b485589e",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "0a0a9a21-7ee8-6bf9-35d7-b385f3f1ccc1",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "61d04e8c-c4d2-7df6-8224-3f8022438b1f",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "5e9d2fb6-aeaa-0dac-63b8-d67cf462e722",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "aee9c5cd-b612-7040-f8dc-017ac31901a0",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1949-10-29T20:51:38.0Z",
"created_at": "1968-06-11T01:11:47.0Z",
"updated_at": "1950-05-28T18:49:07.0Z",
"deleted_at": "1893-08-07T10:27:37.0Z",
"last_active_at": "1967-07-27T23:30:56.0Z",
"email_verified_at": "1911-09-28T14:23:08.0Z",
"last_check_in": {
"checked_in_at": "1929-09-23T18:54:38.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "5a546f5d-8ecf-db34-59e6-c840443f59c8",
"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"
},
"end_date": "1956-11-05T08:14:59.0Z",
"external_ref": "in incididunt do sit est",
"members": [
{
"customer_id": "6fcbf7ba-2b24-1bb8-77c5-5ed605669dd6",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "7daf9041-db44-4066-4306-7466c082d85b",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1891-01-01T23:40:39.0Z",
"next_charge": {
"id": "24f48eb0-41cd-0f54-dcbf-8a3f0b874f01",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1930-07-05",
"billing_period_to": "1941-03-07"
},
"payment_method": {
"id": "ut",
"type": "card",
"last_4": "eiusmod dolore ut exercitation",
"card_brand": "amex"
},
"rate": {
"id": "ceccd833-4a3b-d20e-b27c-511120336de4",
"membership_type_id": "92d5c828-7e8c-b883-edf5-98f3e65ac96b",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolore sunt et"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1934-03-21T01:28:08.0Z",
"updated_at": "1966-12-01T08:40:40.0Z"
},
"site_id": "cdda8c67-ce1f-d5df-fe6b-66feec4a2cf0",
"source": "unknown",
"start_date": "1917-06-01T16:52:24.0Z",
"status": "reserved",
"status_updated_at": "1969-05-16T23:17:19.0Z",
"type": {
"id": "d6b3cc9e-6d29-2683-05ae-593b9ca2b0c1",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "cillum",
"brand_id": "bd99a884-3d0e-7070-a6cd-bd961fd645f1",
"offline_payments": true,
"disable_confirmation_email": false,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1960-11-28T20:29:48.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "3796cd4a-4c87-514e-9716-5101e9d5629b",
"membership_type_id": "65e5ab60-834c-4e91-dfe3-a15e8cf4d2b9",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ipsum aliquip Ut",
"nulla culpa",
"occaecat eu",
"quis voluptate ipsum",
"dolore in dolor esse reprehenderit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1932-09-23T20:37:01.0Z",
"updated_at": "1944-08-24T17:12:38.0Z"
},
{
"id": "d8cc649e-41c9-0979-559d-0726f8723c81",
"membership_type_id": "d9acb66d-c957-37aa-fd08-2f12d004d637",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Lorem nisi"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1938-07-24T05:47:30.0Z",
"updated_at": "1940-10-14T09:09:49.0Z"
},
{
"id": "3b4c249c-5336-56b4-872a-8f91fd19a4c1",
"membership_type_id": "4540f048-16db-4934-da63-d8cba94e1df1",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"mollit ex"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1923-03-21T13:52:13.0Z",
"updated_at": "1947-06-05T16:01:31.0Z"
},
{
"id": "93cba4b1-9f49-3b20-9f29-9afcb550f81e",
"membership_type_id": "1446d541-e378-928a-50f6-bdddf384681d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Ut in sint culpa"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-06-25T01:27:58.0Z",
"updated_at": "1935-05-31T19:20:43.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1912-11-03T09:29:34.0Z",
"updated_at": "1931-09-30T08:59:32.0Z",
"deleted_at": "1959-08-05T01:01:12.0Z"
},
"payment_details_url": "amet",
"created_at": "1939-09-02T04:43:23.0Z"
},
{
"id": "5971de0a-b9ba-5178-7e7f-4512d62d467c",
"attention_reason": "mandate_revoked",
"basket_id": "69c2bcf0b3abb30148000685",
"customer": {
"id": "79f66fc9-3f97-0dda-b74a-98f0eb5b9ed1",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1896-11-27",
"brand_id": "6ddc2988-4783-471e-9fc6-53b87aed0b12",
"site_id": "9e34f375-3784-cdd2-134a-1a0d41f14192",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "f74ec1ab-b112-309b-3fa4-2d2141464734",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "b58e0414-df0b-86a7-86ea-c105dfd10a2f",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "a0fc400b-d1d6-267b-77b6-29eefabe7e08",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "ec564a3f-78f9-efd2-ce88-27817e5c469b",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1895-06-21T03:58:01.0Z",
"created_at": "1946-12-24T22:01:50.0Z",
"updated_at": "1938-10-13T10:18:47.0Z",
"deleted_at": "1909-05-30T04:52:33.0Z",
"last_active_at": "1891-06-08T16:45:09.0Z",
"email_verified_at": "1915-11-20T14:37:16.0Z",
"last_check_in": {
"checked_in_at": "1920-08-11T18:13:06.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "431b241b-1fa9-4914-f709-69ea6c777948",
"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": "Excepteur ipsum pariatur dolore reprehenderit"
},
"end_date": "1945-02-22T20:01:46.0Z",
"external_ref": "laboris esse in",
"members": [
{
"customer_id": "082a3070-a148-9825-da07-85e74a9ff7e5",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "e977ba96-1432-e49f-b93f-9bcf8bc21bfc",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "da5f436f-7fea-95c1-fef8-4ed2bf790f3c",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "581abd13-ed57-1e9a-1830-ba498e5a9f59",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1928-02-04T15:59:24.0Z",
"next_charge": {
"id": "54406ef5-5de9-9719-f86a-f184f5889d2c",
"amount": 3995,
"currency": "GBP",
"status": "failed",
"billing_period_from": "1914-06-14",
"billing_period_to": "1949-02-10"
},
"payment_method": {
"id": "ex",
"type": "card",
"last_4": "in aliquip",
"card_brand": "amex"
},
"rate": {
"id": "75f1521c-6c51-554a-a564-849e52df5d84",
"membership_type_id": "03cb963a-f6a9-bf7b-a702-18508e9aad82",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"est",
"deserunt consequat consectetur",
"culpa reprehenderit Excepteur Ut"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1961-05-06T18:44:41.0Z",
"updated_at": "1898-11-20T05:54:30.0Z"
},
"site_id": "6569e995-18cb-1b3e-c49a-04da28584cec",
"source": "app",
"start_date": "1932-08-17T09:42:08.0Z",
"status": "inactive",
"status_updated_at": "1937-10-14T06:58:51.0Z",
"type": {
"id": "8d329ad6-ff5e-8e65-b926-980f32f26cbd",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "magna aute ipsum deserunt",
"brand_id": "3adb74de-d088-02f1-0c00-2944fe9f3a44",
"offline_payments": false,
"disable_confirmation_email": false,
"private": true,
"visibility": "private",
"minimum_start_date": "1950-05-02T14:51:09.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "ba0da80d-d452-063f-0620-069eefd35ef5",
"membership_type_id": "527e29a0-7fea-07de-d5c7-dd86270ce154",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"consectetur magna eu",
"commodo amet sed magna dolor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1895-12-19T20:23:50.0Z",
"updated_at": "1916-11-27T18:52:45.0Z"
},
{
"id": "eb766457-8c66-3533-6a4c-c5bd54c65f03",
"membership_type_id": "8b5972e7-8fb8-4080-8c28-5d5dc6307bb4",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1893-05-06T01:01:12.0Z",
"updated_at": "1925-05-31T22:38:57.0Z"
},
{
"id": "bff30b62-c42f-f29a-11e3-5627437a4d0d",
"membership_type_id": "02f10ba7-12bb-ba31-fdf8-619c0bc84681",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"esse cillum culpa laborum",
"do Duis pariatur est tempor",
"ut ipsum",
"consectetur ex",
"consectetur ipsum dolore"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1953-07-06T09:24:40.0Z",
"updated_at": "1932-06-15T23:19:18.0Z"
},
{
"id": "ff010665-81cc-ae0e-fca3-972d3e3216f6",
"membership_type_id": "5f33c63c-6a8c-5331-e59e-17b56c7ba616",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1905-04-18T22:57:38.0Z",
"updated_at": "1893-01-15T22:29:59.0Z"
},
{
"id": "8ec0ff9a-0617-6d60-f176-8da2cf4f7933",
"membership_type_id": "a83e9061-4485-86a1-daad-a3737ecf6556",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"quis magna cillum mollit",
"amet Lorem minim",
"aute non",
"adipisicing ad est"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1896-01-07T16:50:55.0Z",
"updated_at": "1958-12-13T01:17:20.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1933-01-29T08:43:21.0Z",
"updated_at": "1948-01-29T15:29:28.0Z",
"deleted_at": "1899-05-31T03:39:41.0Z"
},
"payment_details_url": "est minim sed enim ipsum",
"created_at": "1926-11-21T06:40:54.0Z"
},
{
"id": "a4441c51-048e-3242-3172-3539009c548d",
"attention_reason": "payment_disputed",
"basket_id": "69c2bcf0b3abb30148000686",
"customer": {
"id": "6c39d666-8889-81dc-4655-f8ad84e7ce6e",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1936-11-21",
"brand_id": "a6a056c6-b1a4-bcbc-4b49-c5b2b122f375",
"site_id": "579d461d-8271-74bd-43b1-612b5af37173",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "624a22d2-e3d0-0649-f2fa-2bbf7238e52e",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "6c37e2e6-fe09-af9b-4941-fee0074fa3b8",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "0257a476-2646-e231-39b9-abc72411a267",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1962-01-19T09:07:54.0Z",
"created_at": "1945-03-10T07:49:51.0Z",
"updated_at": "1912-03-13T10:18:36.0Z",
"deleted_at": "1935-06-05T20:39:21.0Z",
"last_active_at": "1905-12-17T23:47:21.0Z",
"email_verified_at": "1968-04-03T04:37:03.0Z",
"last_check_in": {
"checked_in_at": "1941-02-25T03:32:41.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "aa739ba8-64e1-f6b1-8bf0-2aff11ed328e",
"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 ea"
},
"end_date": "1937-01-20T17:24:15.0Z",
"external_ref": "officia",
"members": [
{
"customer_id": "6ee83d97-cfbf-c825-10f2-ad1970589349",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "11b0a890-7146-1438-4c78-f6320f42ca05",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "35049c60-6236-499e-50df-4041516850ac",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "e3f9532b-ae62-c8c5-c7de-18c63eed06ee",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1898-04-30T23:10:17.0Z",
"next_charge": {
"id": "632710ae-3833-1476-276b-7e99c007dbda",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1952-12-14",
"billing_period_to": "1958-01-09"
},
"payment_method": {
"id": "dolore Ut",
"type": "card",
"last_4": "laborum",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "a89b0be4-506c-fddd-fddb-edbbe810c4fd",
"membership_type_id": "7973d231-0be6-2c40-d9d4-0558be32450b",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1967-02-24T07:43:12.0Z",
"updated_at": "1893-01-16T17:13:04.0Z"
},
"site_id": "55559e65-0326-9fc2-eae9-b18824026e1d",
"source": "self_signup",
"start_date": "1922-09-27T12:06:02.0Z",
"status": "needs_attention",
"status_updated_at": "1920-04-21T18:26:18.0Z",
"type": {
"id": "e452589c-881b-0a47-3864-1eb5c64d23c0",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "minim in dolor id esse",
"brand_id": "1745ab23-d147-b769-433f-df3c9768fd50",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "public",
"minimum_start_date": "1901-07-17T03:20:43.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "419fe82b-51fe-9a78-b022-a8c6aa6de93b",
"membership_type_id": "840e1894-9d72-de23-3162-ec0f67a619a5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Ut eiusmod nisi",
"nisi voluptate"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1928-04-16T10:02:19.0Z",
"updated_at": "1916-07-19T07:49:03.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1948-05-03T19:53:28.0Z",
"updated_at": "1904-02-14T13:48:35.0Z",
"deleted_at": "1919-04-26T07:23:39.0Z"
},
"payment_details_url": "dolore veniam Duis dolore ea",
"created_at": "1958-02-08T22:31:31.0Z"
},
{
"id": "31636906-3088-6124-836c-138e5f1ac55c",
"attention_reason": "payment_outstanding",
"basket_id": "69c2bcf0b3abb30148000687",
"customer": {
"id": "c22181c8-0624-a350-5956-49d936313831",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1957-07-31",
"brand_id": "e813c419-9e1a-6753-5d89-d4b703091c26",
"site_id": "bc55fecc-1150-bfba-ac63-98a10e823b08",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "e6613b0a-c17d-53bf-3d87-9aebbf9db3e1",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "973c5892-63e1-6dfb-f197-ebb2a5775e8b",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "1753ce9f-b5cb-257c-19b6-f24fe44f42d1",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "5184ad8b-f8d1-3b76-62d8-8e8157d9595c",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1966-06-01T09:16:55.0Z",
"created_at": "1926-11-27T21:58:10.0Z",
"updated_at": "1929-06-01T21:34:26.0Z",
"deleted_at": "1941-04-17T23:16:11.0Z",
"last_active_at": "1948-04-28T01:36:04.0Z",
"email_verified_at": "1934-04-27T13:29:28.0Z",
"last_check_in": {
"checked_in_at": "1916-02-04T03:12:55.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "aa611abf-084b-67e5-5251-d810fd0e8367",
"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": "occaecat"
},
"end_date": "1941-04-25T13:48:06.0Z",
"external_ref": "commodo dolore qui",
"members": [],
"membership_number": "1234567890",
"next_billing_date": "1914-05-10T11:07:51.0Z",
"next_charge": {
"id": "cc704276-6812-f309-9ab2-0bef9e4407d7",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1965-02-19",
"billing_period_to": "1943-08-25"
},
"payment_method": {
"id": "tempor exercitation aliqua veniam dolor",
"type": "direct_debit",
"last_4": "occaecat culpa aliquip",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "295f1fc3-bc16-d840-49c8-bf6015fc57b7",
"membership_type_id": "d7b6f2c6-29dc-4286-d0a9-3d5cdc54ad7d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1956-07-29T10:53:42.0Z",
"updated_at": "1904-09-21T19:42:38.0Z"
},
"site_id": "34a1c7d6-7377-9051-7c8a-5228046bcf39",
"source": "self_signup",
"start_date": "1938-11-20T11:37:59.0Z",
"status": "active",
"status_updated_at": "1936-09-25T21:40:48.0Z",
"type": {
"id": "f6fad9eb-c609-b53b-cfba-07cf76889b95",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "labore",
"brand_id": "40c0940f-5ec5-707b-cbea-96b4eb76fde6",
"offline_payments": false,
"disable_confirmation_email": false,
"private": true,
"visibility": "private",
"minimum_start_date": "1915-01-27T02:36:56.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "9cc54f2a-0471-11bb-316b-6855e013bd7a",
"membership_type_id": "fa1fd6ef-4bf3-a17c-1172-529c507c8a0a",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"proident",
"labore et ipsum",
"pariatur eiusmod",
"velit exercitation tempor",
"magna"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1896-04-16T06:12:36.0Z",
"updated_at": "1939-09-19T17:10:47.0Z"
},
{
"id": "3ec96e59-030c-85d0-02e2-3fb407004d4b",
"membership_type_id": "b7bd8c26-7353-59d1-7dcb-a5ace69b1a48",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"id ad irure Ut dolore",
"non in cupidatat",
"consequat ad",
"commodo irure"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1894-02-11T20:35:27.0Z",
"updated_at": "1930-10-08T17:41:09.0Z"
},
{
"id": "67952d5c-0b90-e70e-1026-57bf28ff1a8d",
"membership_type_id": "6f54c43c-f3da-aa5b-fbea-a99a05fb89f3",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolor",
"in amet"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1963-11-28T14:11:58.0Z",
"updated_at": "1923-06-05T03:45:25.0Z"
},
{
"id": "9180b12d-a0fb-0db3-4195-b3f530b1a213",
"membership_type_id": "0cabc56f-577d-6574-5d79-557109ebdf9f",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aliquip minim ea labore",
"id quis laboris",
"id elit cillum",
"Duis consequat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1927-06-30T12:24:09.0Z",
"updated_at": "1917-05-30T19:25:06.0Z"
},
{
"id": "84897504-6e0f-9265-6e71-e17e693a971e",
"membership_type_id": "be5d4685-e01a-847f-ce54-587d9cfcdbf5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"nisi eiusmod ullamco in commodo",
"esse adipisicing consectetur quis"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1901-05-23T20:23:19.0Z",
"updated_at": "1890-11-22T09:04:07.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1898-10-05T04:50:40.0Z",
"updated_at": "1912-11-04T02:03:45.0Z",
"deleted_at": "1907-09-15T14:24:12.0Z"
},
"payment_details_url": "quis consequat anim",
"created_at": "1901-10-31T09:13:52.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": "ab7cfbf6-c266-99df-11b1-ff2dafd25269",
"attention_reason": "site_id",
"basket_id": "69c2bcf0b3abb30148000688",
"customer": {
"id": "03466040-5d17-7ff2-b0dd-61aae679bdd0",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1952-06-26",
"brand_id": "97d74215-e0cc-7191-41d1-406c7789a9ad",
"site_id": "ca6b0e07-c7d5-4398-b048-34b5f7d480a7",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1901-01-15T21:37:46.0Z",
"created_at": "1953-10-18T17:48:01.0Z",
"updated_at": "1953-12-08T22:23:07.0Z",
"deleted_at": "1941-01-20T19:57:08.0Z",
"last_active_at": "1914-07-28T23:55:22.0Z",
"email_verified_at": "1898-08-08T16:26:02.0Z",
"last_check_in": {
"checked_in_at": "1967-11-25T15:10:36.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "bdba5913-7d45-d8ac-2a49-2c7758e4730f",
"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": "quis ullamco"
},
"end_date": "1905-06-24T02:27:56.0Z",
"external_ref": "aliqua",
"members": [
{
"customer_id": "c2875708-ea66-d53a-9655-642ffd50d323",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "0e043528-2b5b-ac39-9c20-bdd640e92d3f",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "0fe80a83-c414-ac87-c532-64910e8a33ff",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "f2021e2d-0015-3763-a430-0b601bf3e078",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1956-07-01T18:22:55.0Z",
"next_charge": {
"id": "8c734274-e9ba-ce42-6cc1-808ba471225b",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1912-12-11",
"billing_period_to": "1948-05-20"
},
"payment_method": {
"id": "est sit occaecat eu",
"type": "direct_debit",
"last_4": "dolor dolore ullamco",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "e1187ba3-6fd8-fdca-5663-70560a6c54a6",
"membership_type_id": "d1160fde-01f6-2d4d-6177-e54412ec18c2",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"elit veniam minim eu",
"velit ut",
"ut et id in",
"est enim eu non id"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1928-01-12T12:43:19.0Z",
"updated_at": "1956-05-26T04:17:38.0Z"
},
"site_id": "091e9e5d-6b20-e720-22a8-f2ad70ce22e6",
"source": "import",
"start_date": "1925-01-27T06:19:57.0Z",
"status": "inactive",
"status_updated_at": "1891-08-25T19:43:40.0Z",
"type": {
"id": "2124cadd-ec83-adb6-de75-f1626c90f1b9",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "esse amet in",
"brand_id": "b47b9f25-21b7-2121-8bef-7e2ae83db46e",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "private",
"minimum_start_date": "1957-08-11T04:08:16.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "119b58e3-bf7c-55f7-0ae2-e496ba460038",
"membership_type_id": "e70329a0-826e-bce1-cc5a-d69ba4a11a95",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aliquip Ut occaecat aute cupidatat",
"qui",
"fugiat cupidatat ipsum adipisicing"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1957-09-02T19:46:10.0Z",
"updated_at": "1919-05-12T18:35:37.0Z"
},
{
"id": "ec685969-ac47-d174-1229-de510b7f30f2",
"membership_type_id": "603196c4-3397-29e8-9c82-04ff79bafa6c",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"elit do",
"ad"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1930-05-30T19:58:10.0Z",
"updated_at": "1929-06-13T14:19:34.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1932-10-07T20:29:43.0Z",
"updated_at": "1963-09-07T09:42:08.0Z",
"deleted_at": "1942-11-28T01:53:20.0Z"
},
"payment_details_url": "officia",
"created_at": "1944-12-12T10:13:56.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": "7b536f7f-2c59-2375-65a1-74a251c62c9f",
"membership": {
"id": "a4b14013-0dcc-2747-c356-299fba960961",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "917c988e-03f2-c4e5-2abb-6f05e67e2229",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"processor_type": "Cash",
"processor_type_id": "69c2bcf1b3abb3014800069b"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "et",
"can_download_receipt": true,
"amount_refunded": 62501470,
"refunded": false,
"refunds": [
{
"id": "071026ef-f8fe-4db6-4b3b-6d5b4633e5ea",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "fb9f4e44-f946-af0e-433a-81539dfadd67",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1900-02-18T01:43:07.0Z",
"updated_at": "1965-08-11T20:59:36.0Z"
},
{
"id": "1c968487-7d83-5f2d-29eb-21737bca1f4e",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1951-07-14T18:09:33.0Z",
"updated_at": "1931-08-22T11:02:54.0Z"
},
{
"id": "849d9f3f-77fd-3cb4-b765-e7149631ce81",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "ee066246-e5ac-9243-d853-80c0ca1eb4b7",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1914-02-06T05:11:17.0Z",
"updated_at": "1939-09-25T15:50:32.0Z"
},
{
"id": "689855e7-f4f0-ba37-2909-17d69f587cbc",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"refunded_by": {
"id": "31f82165-c9b8-a696-eaa4-d32dbf65e8a0",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1917-04-22T08:19:48.0Z",
"updated_at": "1897-04-18T19:44:37.0Z"
}
],
"site_id": "0c34d46c-e965-3b18-47e9-39c9fdb2bbe9",
"billing_period_from": "1966-10-30",
"billing_period_to": "1951-05-15",
"processing_at": "1901-11-16T10:55:58.0Z",
"created_at": "1946-09-26T09:07:17.0Z",
"updated_at": "1919-10-29T12:06:03.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": "d1684e72-f23f-a2b8-dcd3-1f9099cbec5d",
"membership": {
"id": "dcf6656e-3bc0-c0cf-e7d8-9d11908883c8",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "2bfbc596-1003-7863-f20b-a0503eda606b",
"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": "irure enim aliquip consectetur",
"can_download_receipt": true,
"amount_refunded": -38009782,
"refunded": true,
"refunds": [
{
"id": "939140f3-d1eb-1c43-2ff9-6d32e4e768a7",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "556921ba-e4ce-679f-a54d-78806e4c5d75",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1957-04-21T14:16:10.0Z",
"updated_at": "1920-12-29T13:36:39.0Z"
},
{
"id": "08de9bef-e686-9412-224c-dd85ffa19f70",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "28a4343d-c1a3-3c00-5840-8d49ca129268",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1890-09-19T04:39:52.0Z",
"updated_at": "1933-05-21T12:01:23.0Z"
}
],
"site_id": "509d9c9b-4f85-2829-8554-ad847048adc8",
"billing_period_from": "1934-08-06",
"billing_period_to": "1930-11-28",
"processing_at": "1902-12-18T01:06:31.0Z",
"created_at": "1925-04-09T02:34:32.0Z",
"updated_at": "1964-03-03T16:31:13.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": "6c99210b-9ef6-eadf-03b3-f2d472a01485",
"membership": {
"id": "1331da38-b61b-8a52-599e-07ba9de0a639",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "a51a4a7a-3b5d-77a8-daad-18468d910ea7",
"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": "irure laboris Lorem",
"can_download_receipt": true,
"amount_refunded": -6039530,
"refunded": true,
"refunds": [
{
"id": "080dadc3-3cc1-8b37-9898-8cfebb4bd252",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "b6c3bd97-63b3-c672-830e-cde1028a32bf",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1900-12-28T14:49:38.0Z",
"updated_at": "1941-03-31T04:33:46.0Z"
},
{
"id": "9e3d3763-34d0-7b50-30a4-436f0a363061",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "3f2e0951-dc98-e23e-8b39-810f138d7df8",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1957-08-01T23:38:20.0Z",
"updated_at": "1942-03-09T11:27:43.0Z"
},
{
"id": "4422c97d-edc0-0388-b428-1b57473dd786",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "7b05b4e8-4d68-175d-68e7-4c7fd63d6374",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1906-03-23T22:07:07.0Z",
"updated_at": "1948-12-27T09:57:06.0Z"
}
],
"site_id": "27bfde53-5998-252d-a65e-e95eeb0b16d1",
"billing_period_from": "1963-07-07",
"billing_period_to": "1899-10-03",
"created_at": "1897-03-12T12:21:57.0Z",
"updated_at": "1947-06-11T15:26:34.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": "69c2bcf1b3abb3014800069c",
"organisation_id": "53ca6d4a-c1fc-21f0-4720-da0a4d76a3cc",
"site_id": "004f68a1-898e-8260-3fa1-a11264ed01c8",
"customer_id": "39ca845a-d657-7412-48e6-a1a075aa92d8",
"membership_id": "b87f5762-377d-afd2-bf67-18fdccc99558",
"from": "Trybe",
"to": "+447123456789",
"message": "pariatur",
"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": {
"incididuntd6": [
"magna velit exercitation",
"pariatur mollit Ut"
]
},
"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": "2b12831d-4daf-0df3-208a-687f62fc96ef",
"organisation_id": "b39fa986-8b22-aefc-45d2-24fd9a74066e"
}
}{
"message": "The requested resource could not be found"
}