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": "b06e2305-3838-9e90-34bb-9da85d87eea6",
"attention_reason": "setup_unpaid",
"basket_id": "6a05e705bd0f7a0156000266",
"customer": {
"id": "9145f891-a13e-6931-fc2c-148f487ec39d",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1965-03-27",
"brand_id": "d49bb80f-7cbf-1d13-f137-e6563eaba5bd",
"site_id": "44d535bb-30c1-f6a3-ac67-47414b5d3dc9",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1893-03-29T23:52:30.0Z",
"created_at": "1912-07-27T20:09:04.0Z",
"updated_at": "1916-12-25T13:16:01.0Z",
"deleted_at": "1942-02-27T19:32:16.0Z",
"last_active_at": "1911-08-12T19:28:56.0Z",
"email_verified_at": "1967-08-01T13:21:25.0Z",
"last_check_in": {
"checked_in_at": "1918-09-23T07:45:04.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "ea0b24dc-d89e-897a-0de7-16d2f0f3150b",
"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": "Duis laboris amet labore"
},
"end_date": "1923-02-21T11:24:21.0Z",
"external_ref": "in nostrud laboris",
"members": [
{
"customer_id": "1e05875f-035f-a88a-de33-3bd65aee1f37",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1919-02-16T13:26:43.0Z",
"next_charge": {
"id": "47d4a633-9661-a5d9-e90e-8b7934f2fe64",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1966-03-12",
"billing_period_to": "1968-01-12"
},
"payment_method": {
"id": "sint",
"card_brand": "amex"
},
"rate": {
"id": "032f225d-95f5-876e-d66a-8dd93ce87896",
"membership_type_id": "753a81e8-766f-8dcd-ba9e-7de335cb1ec3",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut elit quis Lorem est",
"laborum esse",
"aliquip exercitation esse cillum nisi"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1946-04-27T22:28:08.0Z",
"updated_at": "1901-11-07T15:06:17.0Z"
},
"site_id": "27ac28dd-1bb2-3450-af11-39afd57ae84f",
"source": "app",
"start_date": "1931-05-22T10:24:26.0Z",
"status": "expired",
"status_updated_at": "1903-05-12T02:32:24.0Z",
"type": {
"id": "3b2f3a6f-0cac-a3d0-3d95-d384985d098c",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "proident",
"brand_id": "77b07fdc-2978-03a6-0801-b5af02707255",
"offline_payments": false,
"disable_confirmation_email": true,
"private": false,
"visibility": "private",
"minimum_start_date": "1896-10-08T08:05:38.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "2be428f5-a24e-6ad7-7f0f-64a3dc86a6e4",
"membership_type_id": "d6b70b45-6849-b63a-b801-0deb60bcfebe",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"enim",
"ipsum reprehenderit occaecat",
"ipsum sint"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1935-06-22T04:32:20.0Z",
"updated_at": "1964-02-03T02:29:42.0Z"
},
{
"id": "d2924037-af68-6a89-7951-81d6e3c3196a",
"membership_type_id": "0e89cb8b-38a9-352e-ec6a-027c1652a4c4",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1930-01-31T05:27:49.0Z",
"updated_at": "1902-10-17T21:58:40.0Z"
},
{
"id": "399b6ca1-ed9e-0650-8630-e64b280cf2a1",
"membership_type_id": "499af494-ebbf-ec05-c5fb-a0a3729493dc",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"est in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1897-10-14T18:59:01.0Z",
"updated_at": "1960-06-04T04:39:47.0Z"
},
{
"id": "475ac607-4a69-4c34-b091-3b3a812ea934",
"membership_type_id": "1805399f-fe7d-44eb-bcaf-b98c810ab910",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"sunt pariatur",
"elit ullamco Ut quis",
"voluptate mollit in",
"nisi ex in",
"aute exercitation voluptate"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1939-05-02T19:18:46.0Z",
"updated_at": "1898-10-31T09:48:29.0Z"
},
{
"id": "0cd373d6-8bd6-1f2e-9f47-8bd9bb2880c0",
"membership_type_id": "397071a1-d4bb-4d09-1dfd-60652c13fd0b",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"elit adipisicing",
"culpa labore officia in in",
"qui",
"anim"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1953-01-01T23:34:03.0Z",
"updated_at": "1937-04-16T11:29:51.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1930-05-09T08:52:01.0Z",
"updated_at": "1937-09-06T11:15:21.0Z",
"deleted_at": "1891-04-26T18:30:58.0Z"
},
"payment_details_url": "tempor",
"created_at": "1915-07-16T12:55:39.0Z"
},
{
"id": "006ffa99-8da3-96e5-bf28-749020536736",
"attention_reason": "mandate_revoked",
"basket_id": "6a05e705bd0f7a0156000267",
"customer": {
"id": "fbe6dd95-94ff-4ef1-63ae-2cfa51b734d9",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1946-01-22",
"brand_id": "2112ca42-957d-7307-080e-fad7a86fbbd6",
"site_id": "dd881a3d-6cfa-c2d3-4482-83b41a6dfb7e",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "db2daa55-4a5b-ebab-cc54-579eff85e363",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1893-05-06T18:39:04.0Z",
"created_at": "1962-08-30T08:13:02.0Z",
"updated_at": "1895-04-21T19:50:30.0Z",
"deleted_at": "1947-07-06T12:22:56.0Z",
"last_active_at": "1914-10-06T20:03:57.0Z",
"email_verified_at": "1935-02-13T22:32:01.0Z",
"last_check_in": {
"checked_in_at": "1925-10-13T02:59:45.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "77e82294-42fe-e47e-f168-301abc49bf98",
"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": "anim sint ipsum veniam est"
},
"end_date": "1956-07-06T05:49:37.0Z",
"external_ref": "est veniam culpa",
"members": [
{
"customer_id": "662b5d8f-4cf3-e6d7-cc8f-73fe67333990",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "8fcb1b8d-80e0-7e84-3268-410400eb9c68",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "1dc8264b-016a-2871-7739-32c70ed14298",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1965-03-27T04:57:58.0Z",
"next_charge": {
"id": "1fab2479-0708-09ff-3dbd-d68b1aea161f",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1903-01-07",
"billing_period_to": "1897-03-31"
},
"payment_method": {
"id": "sunt culpa officia aute",
"type": "direct_debit",
"last_4": "et laborum minim in sint"
},
"rate": {
"id": "5c5fc1ac-b89c-fc45-044e-ebeb9e6895c6",
"membership_type_id": "8afb68fa-76f4-c9a4-efe0-2cb388ae1fdb",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolore Excepteur",
"nostrud ipsum deserunt",
"occaecat elit aute minim ut",
"et magna ad"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1969-07-01T20:33:06.0Z",
"updated_at": "1961-04-30T20:06:47.0Z"
},
"site_id": "4a5400bc-0a57-3a08-4140-6f3dd311430d",
"source": "app",
"start_date": "1955-11-02T17:35:27.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1967-02-24T01:45:48.0Z",
"type": {
"id": "b1a181b1-1aec-a9ea-d329-58ab2bf1f6d2",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "irure fugiat Ut magna aliquip",
"brand_id": "c536dd1b-1021-19d6-dcdc-fee210131b9c",
"offline_payments": false,
"disable_confirmation_email": false,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1943-06-03T05:53:27.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "fa97273e-bd53-4fcf-2f95-0b780b3b3972",
"membership_type_id": "57331fc9-4eb7-233f-ed7f-82d8b10713c2",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Excepteur enim dolore magna est",
"culpa",
"nostrud aute amet qui"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1932-02-08T14:44:45.0Z",
"updated_at": "1903-09-29T19:28:44.0Z"
},
{
"id": "54cff24a-b4aa-0a58-b988-a4fdbe55bcde",
"membership_type_id": "907720e9-af6c-120f-29f8-6ae248ec433c",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1906-06-17T18:59:50.0Z",
"updated_at": "1896-11-03T08:31:55.0Z"
},
{
"id": "8727df0c-5c53-803f-a3aa-3ab94e7e36be",
"membership_type_id": "6acfedca-04c3-2329-674c-11a679615418",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"anim aliquip in",
"ipsum est"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1900-02-15T20:29:30.0Z",
"updated_at": "1935-01-05T20:09:12.0Z"
},
{
"id": "10c10184-6d33-ad60-75e5-fc391b58ab47",
"membership_type_id": "310aaef7-ff4a-6181-de3a-8628cb5ddc7e",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1917-04-25T05:11:34.0Z",
"updated_at": "1947-11-20T06:52:10.0Z"
},
{
"id": "48739e41-0fd4-5924-f6c1-aee6489ed2ed",
"membership_type_id": "bb53f699-e11d-1e0e-bc4d-f6166bafa748",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"id ut adipisicing Excepteur laboris",
"ea qui",
"sint non in",
"veniam"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1931-12-19T20:19:23.0Z",
"updated_at": "1961-08-28T01:23:15.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1955-08-16T01:46:50.0Z",
"updated_at": "1942-02-08T14:48:38.0Z",
"deleted_at": "1920-03-24T10:10:04.0Z"
},
"payment_details_url": "adipisicing",
"created_at": "1910-03-29T08:43:56.0Z"
},
{
"id": "a3877d8a-992e-5603-bc1b-7700615e0899",
"attention_reason": "site_id",
"basket_id": "6a05e705bd0f7a0156000268",
"customer": {
"id": "34837673-8673-e9f5-bb0b-c7cb08f450ec",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1915-08-13",
"brand_id": "b363909d-9a1e-7d52-ed19-acc11b19368c",
"site_id": "2a7fea04-da31-85f2-2014-2072f5815233",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "41f19273-54a5-51bf-e294-5f358732126a",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "9cb7b289-826a-1cf6-9747-eb234fc13871",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "87259235-6e05-74eb-f02d-f7e002d27640",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1918-05-05T05:30:14.0Z",
"created_at": "1967-09-10T07:01:10.0Z",
"updated_at": "1935-01-19T10:29:14.0Z",
"deleted_at": "1965-05-30T23:05:38.0Z",
"last_active_at": "1901-03-07T08:03:32.0Z",
"email_verified_at": "1916-05-24T01:06:33.0Z",
"last_check_in": {
"checked_in_at": "1925-12-29T03:49:05.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "8ad2efbb-19fd-1f2f-b2f4-f06a6afb63c7",
"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": "consectetur aliqua"
},
"end_date": "1898-01-30T14:19:10.0Z",
"external_ref": "ex cupidatat Duis incididunt in",
"members": [
{
"customer_id": "34c04422-20b3-968f-4276-e2363c144aa4",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "7f841c7f-60f2-9d2d-4d2a-ac3c6ca26f99",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "0ee0229b-9198-fa43-f07f-0971a7dd0c03",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "3f1fa048-118a-709b-c709-6658659b2ce7",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1907-09-14T18:42:29.0Z",
"next_charge": {
"id": "25783a5d-3dcf-606c-2029-a5ce1d5b5d32",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1950-12-28",
"billing_period_to": "1938-10-15"
},
"payment_method": {
"id": "deserunt culpa",
"last_4": "Duis ullamco aliqua",
"card_brand": "amex"
},
"rate": {
"id": "4ff04396-af53-e934-0d08-9c0bf64d004e",
"membership_type_id": "373f5768-10f8-70f5-04bb-67391d3a2e0e",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"consectetur veniam id sit",
"labore",
"laboris sunt",
"deserunt elit labore dolor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1901-12-03T18:50:53.0Z",
"updated_at": "1920-03-23T21:44:29.0Z"
},
"site_id": "d31f1dd1-6df9-f46c-5d96-58abde47f2c1",
"source": "self_signup",
"start_date": "1897-11-18T19:03:54.0Z",
"status": "needs_attention",
"status_updated_at": "1892-07-04T21:19:41.0Z",
"type": {
"id": "49e3b023-fba6-cefe-888f-9ce6048dd96e",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "fugiat eu ipsum",
"brand_id": "5c3269f8-4407-7951-5fe5-3c86b439a58c",
"offline_payments": true,
"disable_confirmation_email": false,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1949-06-13T11:46:34.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "c4e59ca6-3221-5852-8a16-8bc2def16858",
"membership_type_id": "67d0eec5-a4d1-cf65-8141-c6aa895caf73",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ipsum do culpa",
"officia veniam qui laboris laborum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1965-02-10T14:41:20.0Z",
"updated_at": "1947-10-23T08:01:14.0Z"
},
{
"id": "1892d36c-f336-c6b0-96a6-a47931f8ff07",
"membership_type_id": "531a75bc-3bbe-ed38-e232-1cfeb7200497",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"in mollit Duis",
"incididunt Duis in nulla",
"do quis consectetur eiusmod qui",
"officia fugiat",
"eiusmod mollit in amet in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1910-03-23T17:38:07.0Z",
"updated_at": "1899-12-07T11:17:22.0Z"
},
{
"id": "776f7110-3e47-b561-2fec-e2963d056d17",
"membership_type_id": "e5350839-2f2a-77bd-b679-ec947bca1e2d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aute voluptate",
"quis proident aliquip veniam cillum",
"nulla dolor officia",
"pariatur in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1898-03-19T03:38:30.0Z",
"updated_at": "1969-01-20T16:02:18.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1942-05-20T07:07:56.0Z",
"updated_at": "1903-03-07T13:52:15.0Z",
"deleted_at": "1942-02-14T23:20:43.0Z"
},
"payment_details_url": "incididunt fugiat ullamco in laboris",
"created_at": "1963-02-03T16:25:37.0Z"
},
{
"id": "2b818b5e-4b82-3433-a7d4-a0f93648046d",
"attention_reason": "mandate_revoked",
"basket_id": "6a05e705bd0f7a0156000269",
"customer": {
"id": "578ea496-57fb-a6c2-dbaa-562bfe9054fe",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1926-08-31",
"brand_id": "684a525e-3626-a547-7760-7c0d1e84798a",
"site_id": "d021a977-65d1-6c52-8e39-be8d6ac3d855",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "ec8d6ea9-8bd8-57ae-0b36-4440bb4c73a7",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1938-05-14T16:04:19.0Z",
"created_at": "1915-03-02T19:45:47.0Z",
"updated_at": "1923-10-02T07:43:52.0Z",
"deleted_at": "1945-06-02T12:37:08.0Z",
"last_active_at": "1945-07-30T06:01:44.0Z",
"email_verified_at": "1948-08-15T13:49:08.0Z",
"last_check_in": {
"checked_in_at": "1946-03-18T12:15:52.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "9fcb8fd0-3f5c-4878-89da-de2cb71934a3",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"original_url": "https://example.com/media/super-cool-photo.jpg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
},
"external_ref": "culpa"
},
"end_date": "1962-02-25T05:46:02.0Z",
"external_ref": "velit incididunt fugiat",
"members": [
{
"customer_id": "1b2a8f17-8809-671f-be8f-680306f31c50",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "dba1a7ab-4086-a469-f669-567da20a0305",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "39037584-e8d6-9d2a-1631-3ca24ca46399",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1942-08-23T13:33:43.0Z",
"next_charge": {
"id": "0a8dfbcf-0bca-c4f3-e73c-5150ac0bbc7c",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1910-05-10",
"billing_period_to": "1934-05-23"
},
"payment_method": {
"id": "minim",
"type": "card",
"last_4": "laborum adipisicing veniam",
"status": "revoked"
},
"rate": {
"id": "b94bfc17-749e-b801-dce1-7737d01725a0",
"membership_type_id": "5404c62f-69c6-734f-6032-b338af061780",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"magna laborum non",
"in magna laborum",
"cillum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-05-10T16:15:24.0Z",
"updated_at": "1891-12-09T09:08:01.0Z"
},
"site_id": "65d7d314-5131-9670-1648-37cb3f334ff9",
"source": "self_signup",
"start_date": "1897-08-24T12:36:22.0Z",
"status": "inactive",
"status_updated_at": "1936-11-13T07:08:03.0Z",
"type": {
"id": "30f77ef9-812b-d103-9e43-d130cb417637",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "nostrud sed mollit cupidatat commodo",
"brand_id": "5f8ccff1-9535-820b-dc9b-46072f051f80",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1962-09-16T12:17:54.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "a777e39c-2b12-84ea-ffa3-c3d5718f59ef",
"membership_type_id": "3aba41c9-52b3-918b-d834-367322831957",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1899-04-26T16:33:19.0Z",
"updated_at": "1957-06-30T20:07:06.0Z"
},
{
"id": "9de5e67f-192c-6307-d55f-d290ff0d098d",
"membership_type_id": "d95aa75a-e893-9a78-c1cf-4f910d554f75",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"anim sit elit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1933-12-13T08:12:11.0Z",
"updated_at": "1941-07-10T06:51:19.0Z"
},
{
"id": "16e52594-6976-3357-5c11-bccb2c7d3931",
"membership_type_id": "0fb9393d-0afb-766d-3881-81dcf5d9f7a3",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"non ut veniam dolor",
"proident sed aliqua exercitation consequat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1897-02-22T11:31:35.0Z",
"updated_at": "1965-07-06T07:34:53.0Z"
},
{
"id": "09125f9f-fe65-bf21-e06a-229f34b98f70",
"membership_type_id": "c82d8377-8d54-6ab2-3b79-b6c3726376c7",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"officia reprehenderit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1904-12-16T01:47:43.0Z",
"updated_at": "1958-12-30T20:33:51.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1922-03-09T20:07:28.0Z",
"updated_at": "1962-08-03T18:03:41.0Z",
"deleted_at": "1908-03-23T10:59:42.0Z"
},
"payment_details_url": "ex anim cupidatat",
"created_at": "1940-02-09T06:51:40.0Z"
},
{
"id": "c0bbfb43-54a5-ae8e-3127-edc284f2ee4c",
"attention_reason": "payment_failed",
"basket_id": "6a05e705bd0f7a015600026a",
"customer": {
"id": "f52833c0-9480-07b6-7998-2f8f8235bfc1",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1949-04-29",
"brand_id": "bc62fc3d-d38c-c92c-2449-ff8103a430d1",
"site_id": "0ea9e0f7-3380-a540-1211-7b9a5f44c2e4",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "6414c64f-66e8-0d92-c8b7-4c693dd10606",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "fa097774-94a3-fbf4-0f0e-577946b335f6",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1912-07-06T22:41:22.0Z",
"created_at": "1899-06-15T05:08:48.0Z",
"updated_at": "1959-10-26T18:42:15.0Z",
"deleted_at": "1957-11-10T12:45:52.0Z",
"last_active_at": "1969-05-07T22:45:12.0Z",
"email_verified_at": "1922-06-17T08:06:20.0Z",
"last_check_in": {
"checked_in_at": "1952-09-15T21:48:32.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "8d32dcee-fde5-3dca-569a-f7ecaf83926a",
"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": "dolore ea deserunt veniam"
},
"end_date": "1935-10-24T19:41:51.0Z",
"external_ref": "in sit labore aliqua",
"members": [
{
"customer_id": "d8dfa44b-df58-1d30-816c-34ccd8764736",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1924-09-23T17:46:52.0Z",
"next_charge": {
"id": "d20724e5-a9d1-f85c-3795-f0ca965cf45f",
"amount": 3995,
"currency": "GBP",
"status": "awaiting_approval",
"billing_period_from": "1900-01-20",
"billing_period_to": "1963-04-06"
},
"payment_method": {
"id": "esse fugiat incididunt",
"type": "card",
"last_4": "dolore irure",
"card_brand": "amex"
},
"rate": {
"id": "e79f6075-2b11-f9d5-3113-c28d58b3f8bd",
"membership_type_id": "821ad9c0-cb63-7f77-f2bd-04dc98ceb5c5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"adipisicing dolor aute ea",
"labore tempor non in",
"proident consectetur cillum adipisicing ut"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1959-02-20T08:50:12.0Z",
"updated_at": "1894-07-24T20:51:32.0Z"
},
"site_id": "c3fee665-a6fe-1f32-dca4-c8efef30ab4c",
"source": "import",
"start_date": "1893-01-08T11:12:35.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1938-05-06T22:15:49.0Z",
"type": {
"id": "73186424-b25f-8b82-2322-b3a37c139774",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "qui",
"brand_id": "45e609d1-40f5-814f-f663-bf769c37a5e4",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1969-01-12T01:48:50.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1897-07-22T06:05:26.0Z",
"updated_at": "1968-07-17T20:44:02.0Z",
"deleted_at": "1922-01-28T01:05:25.0Z"
},
"payment_details_url": "aliqua adipisicing dolor",
"created_at": "1947-05-20T14:58:45.0Z"
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}getMembershipUse this endpoint to retrieve a Membership by its ID.
membershipIdThe ID of the membership
{
"data": {
"id": "caa5d8dc-8f5e-dc9a-acc9-c39ae089bc5e",
"attention_reason": "payment_disputed",
"basket_id": "6a05e705bd0f7a015600026b",
"customer": {
"id": "07b92013-3542-e66e-ece8-b705f9d826ca",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1896-09-06",
"brand_id": "4029553f-6f25-b1b0-0a3b-d52e464e9074",
"site_id": "82186c52-503e-d926-fd1f-019af83fde93",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1910-09-22T19:29:01.0Z",
"created_at": "1911-04-27T13:30:07.0Z",
"updated_at": "1930-09-22T10:48:09.0Z",
"deleted_at": "1893-07-21T23:25:18.0Z",
"last_active_at": "1923-01-24T17:12:49.0Z",
"email_verified_at": "1936-10-02T21:37:32.0Z",
"last_check_in": {
"checked_in_at": "1899-06-07T04:01:19.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "f29deac7-616b-240f-374e-3fd14c64fdc5",
"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": "et nostrud incididunt dolor"
},
"end_date": "1962-12-09T17:06:30.0Z",
"external_ref": "Duis proident pariatur",
"members": [
{
"customer_id": "2544a834-3095-0e90-b628-d24916f9abe8",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "45355953-e2fb-4cc8-3671-694f2516ed01",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1908-06-26T01:42:38.0Z",
"next_charge": {
"id": "0130bd6f-79bb-a183-1320-860120637ce6",
"amount": 3995,
"currency": "GBP",
"status": "pending",
"billing_period_from": "1951-09-13",
"billing_period_to": "1925-11-21"
},
"payment_method": {
"last_4": "dolor",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "f646423b-ec97-ae57-b0cd-0c65b6d5aaa1",
"membership_type_id": "f7005709-6b61-bb25-0a27-5284c58522df",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"elit",
"ut",
"incididunt dolor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1938-03-29T05:17:53.0Z",
"updated_at": "1947-12-15T05:04:57.0Z"
},
"site_id": "50903e91-b8c7-eff3-0819-8cef2a0115d0",
"source": "import",
"start_date": "1956-05-18T05:44:46.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1900-04-09T02:25:40.0Z",
"type": {
"id": "3949ef5e-7e12-356b-e938-fa3bd2d6c1ec",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "ipsum",
"brand_id": "2015c731-3244-af37-4ed4-ae8965cf37e5",
"offline_payments": false,
"disable_confirmation_email": false,
"private": false,
"visibility": "private",
"minimum_start_date": "1913-06-25T01:07:53.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1930-02-11T18:50:04.0Z",
"updated_at": "1944-12-20T21:16:01.0Z",
"deleted_at": "1969-03-10T15:37:32.0Z"
},
"payment_details_url": "laborum",
"created_at": "1944-04-11T15:33:51.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": "db298048-b85b-5b6e-bd46-e690a73cdc5a",
"membership": {
"id": "b03d78fe-9633-2a69-2140-5c765fcddae4",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "fc70be08-2fca-875c-6101-3ec4eb1eb6b6",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "fugiat velit",
"can_download_receipt": true,
"amount_refunded": 85111145,
"refunded": false,
"refunds": [
{
"id": "a9b95153-3b6f-9760-d0f0-608cf554dbc0",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1918-06-19T11:19:41.0Z",
"updated_at": "1905-08-14T01:58:12.0Z"
},
{
"id": "b1e2b9f0-ee86-09a2-8cd2-bfb79185fe17",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "262629e8-3a02-e43e-1d1b-d1cd1bdba1a1",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1942-06-26T01:20:22.0Z",
"updated_at": "1967-07-21T09:56:14.0Z"
}
],
"site_id": "c576475e-0e29-ae79-4f68-8de0ab2cb52e",
"billing_period_from": "1954-06-14",
"billing_period_to": "1969-06-03",
"processing_at": "1938-07-03T01:37:22.0Z",
"created_at": "1957-09-30T20:27:54.0Z",
"updated_at": "1892-03-09T23:48:27.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": "f0b89300-d7d4-c1d2-c7d3-4b492e7d980b",
"membership": {
"id": "ea1ff3a5-f5d6-cc6e-9f3d-e03e44435671",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "d1e23f74-cf67-ed0e-1423-f6dc4a31b9a3",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "commodo eu ipsum amet",
"can_download_receipt": false,
"amount_refunded": 16426850,
"refunded": true,
"refunds": [
{
"id": "84f109d3-86ce-ee84-273d-a33d45a71c0c",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "67105e6c-2a57-c828-bd7d-172e76cd213c",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1949-01-13T12:12:50.0Z",
"updated_at": "1965-10-14T01:17:59.0Z"
},
{
"id": "db7ffe3a-867d-ce02-f8e8-587b54641518",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "00ee40c1-b974-591b-75f1-90089e6aebc6",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1957-06-06T08:23:16.0Z",
"updated_at": "1947-03-11T01:19:12.0Z"
},
{
"id": "4747da29-bc83-534b-aa6a-3327b40aec4a",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "e5b6f253-819e-8cc5-385c-b896342ca085",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1907-06-18T22:05:42.0Z",
"updated_at": "1930-08-12T14:03:10.0Z"
},
{
"id": "322b705c-007c-b58f-035f-b4b0868cbc48",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "a6715947-2cdc-d7cc-a5d2-b09448357cf1",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1947-07-18T08:27:39.0Z",
"updated_at": "1907-06-23T04:48:49.0Z"
}
],
"site_id": "85c5c9aa-aea0-0b96-96fe-ecb2c45dc591",
"billing_period_from": "1890-12-20",
"billing_period_to": "1936-03-18",
"created_at": "1954-02-23T18:46:02.0Z",
"updated_at": "1967-04-01T22:42:30.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": "4c991f75-09d9-7eba-bdc4-2db781ec9146",
"membership": {
"id": "4de28edf-4ab8-a25f-43c6-e4672cc7eef9",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "d413c25c-a329-3a71-31f4-4894506ec813",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "6a05e705bd0f7a015600026c"
},
"amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "dolore laboris sint dolor velit",
"can_download_receipt": true,
"amount_refunded": 88050366,
"refunded": true,
"refunds": [
{
"id": "bd3a11ce-0e50-3871-d605-20720477666e",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "676816e9-2520-0106-cc99-f961339f93f1",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1957-07-08T04:22:42.0Z",
"updated_at": "1945-01-14T07:29:28.0Z"
},
{
"id": "535d417a-c2c0-f28f-b3d7-7efdbcfd7605",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "45a312a3-7177-2744-2e09-501c30578e97",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1959-11-14T20:32:59.0Z",
"updated_at": "1915-08-12T01:09:52.0Z"
},
{
"id": "511e2fbb-e945-c228-d49b-454ae1c66f48",
"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": "1900-11-05T03:02:15.0Z",
"updated_at": "1954-10-08T21:05:40.0Z"
},
{
"id": "4612e2b9-5795-ee97-9906-98f61d5c950d",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "bd703d36-ea02-6df6-5abe-57dbca56eaed",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1938-08-10T07:17:24.0Z",
"updated_at": "1953-01-08T12:44:12.0Z"
}
],
"site_id": "aea24307-9456-8922-e110-db1fcff31736",
"billing_period_from": "1964-07-27",
"billing_period_to": "1894-03-28",
"created_at": "1941-04-13T15:04:20.0Z",
"updated_at": "1942-03-13T06:10:29.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": "6a05e706bd0f7a01560005ea",
"organisation_id": "ac8b79b3-dec6-4f32-9f60-a19ce2b53bce",
"site_id": "14e8e6a4-2f72-3acf-ad7b-4fd0c2aa0ad4",
"customer_id": "c33e6603-5e95-2792-dee6-6e21bdcd1e77",
"membership_id": "eea13b47-5852-b6b8-3070-5d2bf941cc03",
"from": "Trybe",
"to": "+447123456789",
"message": "Lorem proident Ut laborum ullamco",
"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": {
"quisea": []
},
"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": "02a798d5-eb6e-670f-16f8-373f3e499c2c",
"organisation_id": "aee889c5-2939-221a-ac28-65ffb5db4f6b"
}
}{
"message": "The requested resource could not be found"
}