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.
The 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.
The 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": "8ca7d203-6957-6b24-8883-a900b753288d",
"attention_reason": "payment_outstanding",
"basket_id": "698c4d39022bd401370000b6",
"customer": {
"id": "a16be447-c9d4-ed55-6703-734d68911f78",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1965-03-17",
"brand_id": "8320a2f2-7f39-89e8-01e5-ecb342d95087",
"site_id": "3baa747b-7af1-5108-161e-eba32df64265",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "b89e3372-cc3a-6454-039e-276e13e5c662",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1919-09-12T06:51:26.0Z",
"created_at": "1950-01-08T04:56:35.0Z",
"updated_at": "1944-02-24T12:56:22.0Z",
"deleted_at": "1968-11-11T19:07:10.0Z",
"last_active_at": "1896-05-18T14:01:02.0Z",
"email_verified_at": "1916-07-01T08:08:05.0Z",
"last_check_in": {
"checked_in_at": "1895-04-28T21:14:40.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "458cd2c7-e54f-2c57-8662-cfa8d97fee10",
"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": "mollit amet culpa commodo"
},
"end_date": "1942-09-18T08:23:34.0Z",
"external_ref": "dolor",
"members": [
{
"customer_id": "86d57831-98fb-03fe-ae2d-411438ca0585",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "8d8dbe30-fd6b-7acb-1099-ce99ab1873ad",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "fecccde0-0877-7e7d-9158-bf54bbb0bdf5",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "cf60bafc-7dc2-bd0e-21fb-f6266e878236",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "41f45534-1b51-d050-12c1-6f8ec3f904a2",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1914-11-18T18:19:36.0Z",
"next_charge": {
"id": "893f7ba2-9f6d-3b55-1774-3002cc2030ff",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1953-04-24",
"billing_period_to": "1927-07-04"
},
"payment_method": {
"id": "sit ut aute irure in"
},
"rate": {
"id": "df201c9e-76a5-8ee4-9491-922a8e753bfa",
"membership_type_id": "6f07aded-5480-ea9a-1a20-3c432965ae0c",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"nostrud ullamco",
"enim ullamco",
"occaecat Ut dolor"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1960-10-30T11:23:57.0Z",
"updated_at": "1904-09-06T09:38:59.0Z"
},
"site_id": "d1e403b7-62fb-19e2-be19-dc3797944629",
"source": "app",
"start_date": "1949-06-24T17:15:47.0Z",
"status": "inactive",
"status_updated_at": "1934-10-19T01:13:11.0Z",
"type": {
"id": "35098f60-2d7f-f6c8-858f-b72faa0d6ab5",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "nisi quis fugiat Ut",
"brand_id": "daef487a-8cac-9164-bfc5-18de6d7e4986",
"offline_payments": true,
"disable_confirmation_email": true,
"private": true,
"visibility": "public",
"minimum_start_date": "1961-11-10T11:29:45.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "3ac26e2a-b64e-eca4-437a-806e1c9add8a",
"membership_type_id": "230633b7-1c4a-934d-4207-04e0912684ef",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"nisi",
"consectetur aute ad culpa",
"in in est sunt consequat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1907-12-24T15:01:49.0Z",
"updated_at": "1921-06-01T22:47:29.0Z"
},
{
"id": "6e01ed53-6820-85e9-c65e-6858ed618c27",
"membership_type_id": "1e210405-a4a1-510d-e114-d0a53bc303fb",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aliquip dolore reprehenderit",
"dolor incididunt ut nulla aliqua",
"irure",
"amet",
"ut quis non qui commodo"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1953-03-11T15:54:19.0Z",
"updated_at": "1966-07-04T04:27:40.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1917-06-19T14:43:38.0Z",
"updated_at": "1934-01-25T14:36:33.0Z",
"deleted_at": "1939-01-09T10:36:53.0Z"
},
"payment_details_url": "pariatur voluptate quis dolore",
"created_at": "1898-02-13T17:02:51.0Z"
},
{
"id": "246da572-c0d2-ec03-9a3f-220e3ca80471",
"attention_reason": "payment_disputed",
"basket_id": "698c4d39022bd401370000b7",
"customer": {
"id": "9eacf591-783a-bb1b-3433-ba329153fb03",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1906-01-29",
"brand_id": "0d38ad12-62f8-e949-eb6e-a3c5a9d4f133",
"site_id": "107ab2a3-670f-c54d-b6b0-53a910c41bee",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "bce1fda3-62c5-9126-b5db-8bece63eb963",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1940-07-31T08:29:34.0Z",
"created_at": "1931-01-31T15:11:32.0Z",
"updated_at": "1952-12-18T07:14:03.0Z",
"deleted_at": "1967-09-16T01:27:29.0Z",
"last_active_at": "1916-03-16T20:08:48.0Z",
"email_verified_at": "1933-01-22T17:58:34.0Z",
"last_check_in": {
"checked_in_at": "1895-05-08T07:03:50.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "f5bb9225-e865-e2de-2d19-a4da0c26ed06",
"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": "cupidatat aute proident"
},
"end_date": "1921-04-17T03:13:54.0Z",
"external_ref": "elit",
"members": [
{
"customer_id": "1e121d16-4ba4-9dd5-e064-f2320e7dfd23",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1959-09-26T20:59:53.0Z",
"next_charge": {
"id": "b4ad9a77-dea4-1874-54e9-963ed8d750da",
"amount": 3995,
"currency": "GBP",
"status": "processing",
"billing_period_from": "1894-08-09",
"billing_period_to": "1951-12-19"
},
"payment_method": {
"id": "do",
"last_4": "incididunt cupidatat id esse",
"card_brand": "amex"
},
"rate": {
"id": "73847a41-9a2a-f376-3055-6922f50f3a3f",
"membership_type_id": "ec2a9f25-6af8-f760-92b0-0519dcc198c5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"Ut enim aliqua Excepteur sed",
"in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1946-03-17T05:06:23.0Z",
"updated_at": "1902-05-18T07:01:48.0Z"
},
"site_id": "f6de523b-bde8-8801-d1c2-3a6e6bb7214f",
"source": "import",
"start_date": "1920-09-05T22:12:39.0Z",
"status": "upcoming",
"status_updated_at": "1900-06-19T20:37:57.0Z",
"type": {
"id": "78dbb4a6-f47b-ec19-79e4-7b0f91109c0f",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "commodo consectetur sed qui in",
"brand_id": "ef2c24c0-bde5-e56d-0a76-2960be03554e",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "public",
"minimum_start_date": "1899-06-15T03:54:39.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "c5601f7c-2ddf-6242-ea3e-8b8b783f129d",
"membership_type_id": "3bd036be-e35d-30aa-bbb8-f60503bec0fe",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"cillum sunt cupidatat laborum",
"in dolor dolore pariatur laborum",
"laboris",
"in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1912-03-21T21:44:27.0Z",
"updated_at": "1903-12-28T13:40:57.0Z"
},
{
"id": "e14b6e33-f15d-5661-b5ff-c51b8a45634b",
"membership_type_id": "0f9f6f76-6f41-6c39-b96e-995c7c051b94",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut nostrud"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1920-07-22T04:19:57.0Z",
"updated_at": "1897-02-07T15:54:58.0Z"
},
{
"id": "cf758ab8-eace-2cbd-b6bb-9a247605797f",
"membership_type_id": "54b2f183-9183-24d9-3307-ebc7347d0067",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laboris ut est fugiat mollit",
"irure Excepteur consequat"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1916-04-01T20:22:50.0Z",
"updated_at": "1958-03-10T15:31:14.0Z"
},
{
"id": "f5d47f6c-d82e-3ed8-0cca-c052136ed0d7",
"membership_type_id": "2947cfeb-cc91-d4aa-d24f-af3ab03f8827",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"irure consectetur",
"ad",
"pariatur consequat exercitation aliqua",
"id",
"dolor enim ipsum amet laborum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1919-11-03T15:20:44.0Z",
"updated_at": "1961-12-24T08:07:24.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1951-05-01T14:55:29.0Z",
"updated_at": "1951-08-15T06:31:11.0Z",
"deleted_at": "1944-01-14T22:42:57.0Z"
},
"payment_details_url": "quis",
"created_at": "1909-04-23T02:55:08.0Z"
},
{
"id": "d6dd0b06-438b-b2c4-0cf4-fc9b4a06244d",
"attention_reason": "mandate_revoked",
"basket_id": "698c4d39022bd401370000b8",
"customer": {
"id": "5d52e127-c5cd-f0c6-3b61-2c32b2ed9cb7",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1923-07-21",
"brand_id": "2b563a46-4e39-006b-d8d7-30cdbc82c8ff",
"site_id": "ac069612-e156-a94f-f3dc-b31226928811",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "018d6033-21f5-fe1e-b0ff-73d2958f59f2",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "e6b5234e-da2a-71a5-8cc0-6af42b082aa4",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "66a6148d-9ff0-78fe-0453-44678370b4b5",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "e5880a7b-b50e-0327-dd24-e110703e64d1",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1960-11-13T21:18:48.0Z",
"created_at": "1966-05-03T19:39:22.0Z",
"updated_at": "1957-11-28T01:49:46.0Z",
"deleted_at": "1965-07-28T23:12:03.0Z",
"last_active_at": "1894-06-06T18:15:56.0Z",
"email_verified_at": "1953-03-04T10:54:06.0Z",
"last_check_in": {
"checked_in_at": "1906-02-16T01:32:30.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "303e2c75-ffb0-4f28-05fe-2ca9436b261f",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"original_url": "https://example.com/media/super-cool-photo.jpg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
},
"external_ref": "elit voluptate ut"
},
"end_date": "1931-11-01T04:48:17.0Z",
"external_ref": "fugiat aliquip",
"members": [
{
"customer_id": "61028df6-b7c3-0349-bf40-818d33805bf1",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1950-10-29T19:01:42.0Z",
"next_charge": {
"id": "f85607ce-898f-9898-9a90-3f9a6e7d5c9f",
"amount": 3995,
"currency": "GBP",
"status": "processing",
"billing_period_from": "1953-01-17",
"billing_period_to": "1904-06-11"
},
"payment_method": {
"id": "dolor ad magna proident",
"type": "direct_debit",
"last_4": "officia",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "af67ee56-55ea-1871-2bdc-b6f1e1351420",
"membership_type_id": "30819a33-f32f-3af4-17c2-39d1f0653cd3",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"dolore officia do pariatur adipisicing"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1953-08-31T05:32:27.0Z",
"updated_at": "1946-08-05T01:49:13.0Z"
},
"site_id": "c21baf24-eaa9-d2d5-1421-a8b3172890ca",
"source": "import",
"start_date": "1933-03-28T01:31:14.0Z",
"status": "expired",
"status_updated_at": "1902-07-11T16:21:58.0Z",
"type": {
"id": "9c672e06-dc58-f73b-4587-9918699f0cdd",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "Ut dolor minim enim",
"brand_id": "9c5d709d-28de-aaae-12a8-9167aeaa75a3",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "public",
"minimum_start_date": "1915-08-08T12:04:51.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "dd491a7a-7ae4-dac3-a957-2ed0f8461259",
"membership_type_id": "362ddf3b-7df1-c2cb-aef9-c5c8935ce4dc",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"non cillum voluptate consequat",
"nostrud proident veniam dolor incididunt",
"aliquip laborum occaecat dolor id"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1937-05-08T14:38:31.0Z",
"updated_at": "1910-11-23T01:04:56.0Z"
},
{
"id": "da43805a-385f-bebc-adf9-9fc4600f4a82",
"membership_type_id": "a2b3d9a1-53d1-4a3d-9384-7ab4bb77b72d",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1930-02-07T05:52:06.0Z",
"updated_at": "1903-12-22T23:42:43.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1909-08-01T18:56:05.0Z",
"updated_at": "1942-08-26T15:30:31.0Z",
"deleted_at": "1924-07-01T19:07:21.0Z"
},
"payment_details_url": "exercitation est officia",
"created_at": "1896-03-11T01:18:54.0Z"
},
{
"id": "5c2e75e2-cebb-49a9-cba8-2a4a6c606725",
"attention_reason": "no_mandate",
"basket_id": "698c4d39022bd401370000b9",
"end_date": "1891-03-22T05:44:01.0Z",
"external_ref": "proident et",
"members": [
{
"customer_id": "c50ebbd1-b0c7-1473-a8ea-37c594e3d991",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1894-12-03T01:35:07.0Z",
"payment_method": {
"last_4": "ut in",
"status": "revoked",
"card_brand": "amex"
},
"rate": {
"id": "68591b7b-c39a-449f-dab4-b3cc375f09c3",
"membership_type_id": "60abbad2-4587-384d-1fbf-37f533e071f8",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"et",
"nostrud",
"dolore nisi amet"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1963-07-20T20:19:01.0Z",
"updated_at": "1945-02-23T18:07:55.0Z"
},
"site_id": "41d8de4b-20fc-8b79-97f1-8aff262ffd94",
"source": "self_signup",
"start_date": "1967-04-02T13:50:34.0Z",
"status": "needs_dd_mandate",
"status_updated_at": "1905-04-24T13:30:25.0Z",
"type": {
"id": "3239146d-463f-b989-3d4d-243e729047de",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "ex in ad dolore cillum",
"brand_id": "30483019-b39d-cbe2-2548-0a184b823494",
"offline_payments": false,
"disable_confirmation_email": false,
"private": true,
"visibility": "private",
"minimum_start_date": "1949-09-12T11:41:27.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1967-09-02T11:19:09.0Z",
"updated_at": "1960-09-23T19:35:07.0Z",
"deleted_at": "1892-03-13T15:39:27.0Z"
},
"payment_details_url": "id tempor ad",
"created_at": "1897-01-12T16:58:11.0Z"
},
{
"id": "f9b691eb-d886-e71b-26bb-f2a7c91071f1",
"attention_reason": "payment_disputed",
"basket_id": "698c4d39022bd401370000ba",
"customer": {
"id": "c140f720-8e4f-9994-8caa-9f5ed91007e5",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1941-10-05",
"brand_id": "15332f72-0905-fda1-aed8-afc9a121cce6",
"site_id": "4b75dd72-c0af-4297-a0b8-951bdbecdc1a",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "d6125648-0b21-ad4f-7abc-438e27e00006",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1892-06-07T01:41:47.0Z",
"created_at": "1926-08-02T05:33:32.0Z",
"updated_at": "1897-08-09T05:19:54.0Z",
"deleted_at": "1949-05-26T05:33:06.0Z",
"last_active_at": "1925-07-10T01:05:08.0Z",
"email_verified_at": "1917-08-05T22:26:10.0Z",
"last_check_in": {
"checked_in_at": "1891-06-30T05:31:21.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "4a0291be-4b9a-4f9f-8fc2-02704674690d",
"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": "pariatur Duis fugiat laborum esse"
},
"end_date": "1948-01-14T16:47:27.0Z",
"external_ref": "anim elit reprehenderit in ut",
"members": [
{
"customer_id": "70e47a95-dff9-1377-5a26-90d368e7c9b2",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "800c99db-5041-ce5c-bede-845ce9e0006b",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "22fe2a8f-5fff-e2e6-b4c7-683c016f07b1",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "975d1376-17c8-a269-8493-d25ce827bb66",
"is_lead": false,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1941-10-18T04:39:18.0Z",
"next_charge": {
"id": "af3b85ea-6cad-45a8-452d-4a12a87b42b8",
"amount": 3995,
"currency": "GBP",
"status": "processing",
"billing_period_from": "1946-05-09",
"billing_period_to": "1899-04-09"
},
"payment_method": {
"last_4": "in sed laboris"
},
"rate": {
"id": "7d9b17d8-4ee9-2eb9-35c6-1b382f4d3e83",
"membership_type_id": "50965935-ca1c-f6d4-c41f-8ba8875a1813",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"do magna eu",
"incididunt"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1922-01-07T02:48:05.0Z",
"updated_at": "1907-08-31T18:07:22.0Z"
},
"site_id": "e9c0cfc6-2ae4-fd60-26bb-94af530e9351",
"source": "self_signup",
"start_date": "1968-04-18T12:25:08.0Z",
"status": "expired",
"status_updated_at": "1916-09-06T07:23:21.0Z",
"type": {
"id": "4a513c67-d692-3fe5-ff1b-de2ea194120c",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "anim dolore in deserunt",
"brand_id": "7b45c33d-d7e8-89f7-c6d6-978d3a57fb9c",
"offline_payments": true,
"disable_confirmation_email": true,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1951-10-17T13:08:52.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1961-05-14T05:28:53.0Z",
"updated_at": "1916-12-03T18:49:43.0Z",
"deleted_at": "1968-08-14T16:12:49.0Z"
},
"payment_details_url": "in Lorem culpa dolor fugiat",
"created_at": "1898-03-17T10:39:46.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": "6b2654cb-f363-2f06-4629-78bb3e2d2465",
"attention_reason": "payment_outstanding",
"basket_id": "698c4d39022bd401370000bb",
"customer": {
"id": "35e21b9f-b973-b355-f8d8-a6e2e0325f73",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1941-02-07",
"brand_id": "fcfa6657-aa7f-cec3-e128-6ed96a0bbe81",
"site_id": "93eb7050-f36a-2ca8-1388-8cbabd80210e",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "aed24539-cf36-98ed-6d38-007bf4ae268c",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1950-05-20T14:31:51.0Z",
"created_at": "1918-01-05T05:17:09.0Z",
"updated_at": "1949-02-09T11:01:31.0Z",
"deleted_at": "1957-07-01T20:28:37.0Z",
"last_active_at": "1934-02-02T13:11:32.0Z",
"email_verified_at": "1904-11-09T18:24:19.0Z",
"last_check_in": {
"checked_in_at": "1926-03-22T01:32:25.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "9e72c498-89a5-f097-9b38-b6ee94129c70",
"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": "qui elit occaecat cillum"
},
"end_date": "1911-02-19T21:06:01.0Z",
"external_ref": "ea incididunt",
"members": [
{
"customer_id": "b6b9a2b5-1d06-719b-b31e-5772aefe19d8",
"is_lead": true,
"membership_number": "1234567890"
},
{
"customer_id": "21383626-c316-04da-a2df-68a2a6316285",
"is_lead": false,
"membership_number": "1234567890"
},
{
"customer_id": "d2602b56-bcd1-d3d0-6b13-a48df039d3bd",
"is_lead": true,
"membership_number": "1234567890"
}
],
"membership_number": "1234567890",
"next_billing_date": "1930-11-12T05:47:48.0Z",
"next_charge": {
"id": "41bb54e4-eb44-02eb-2489-7193be8537fc",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1935-06-25",
"billing_period_to": "1927-12-04"
},
"payment_method": {
"id": "ut quis reprehenderit in",
"type": "direct_debit",
"last_4": "ad deserunt Excepteur aliqua",
"status": "revoked"
},
"rate": {
"id": "240f3a36-847d-2fc7-1b07-b3b4da674540",
"membership_type_id": "89720fdc-26e3-07a9-a3a7-1c08ea169ea6",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1923-02-17T12:42:55.0Z",
"updated_at": "1908-12-31T18:04:28.0Z"
},
"site_id": "4c615f9c-2c8d-4bbc-09e3-7f6d91ae497b",
"source": "import",
"start_date": "1914-11-28T19:08:36.0Z",
"status": "expired",
"status_updated_at": "1925-02-20T12:24:57.0Z",
"type": {
"id": "4ed96582-ca49-2023-a02a-807d78335c38",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "incididunt cillum Duis consequat",
"brand_id": "21762707-384d-0b78-0172-93f66464c7dd",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "private",
"minimum_start_date": "1902-03-29T23:25:03.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1926-08-18T10:53:56.0Z",
"updated_at": "1905-05-30T01:29:52.0Z",
"deleted_at": "1941-09-02T10:01:25.0Z"
},
"payment_details_url": "fugiat sint Lorem",
"created_at": "1904-09-05T04:56:47.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": "d3374a68-ffb9-7e36-eca6-14972d0b3c10",
"membership": {
"id": "c0e35625-a5b1-ba46-131d-79b217fa1c1f",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "190d882e-7ddb-53ff-902c-e2c7ef72ce63",
"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": "Excepteur eiusmod cupidatat in officia",
"can_download_receipt": false,
"amount_refunded": 48701859,
"refunded": true,
"refunds": [
{
"id": "1f313592-ea60-7b75-8a35-18947eba96f9",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"refunded_by": {
"id": "05f793d0-ccac-0a9f-6a73-5ce6e2626e0b",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1918-01-07T05:13:58.0Z",
"updated_at": "1964-04-17T19:24:24.0Z"
}
],
"site_id": "80d1f198-04c2-7285-fd50-1b25e99e7757",
"billing_period_from": "1907-01-31",
"billing_period_to": "1929-10-26",
"processing_at": "1907-06-26T03:11:36.0Z",
"created_at": "1908-05-05T12:40:34.0Z",
"updated_at": "1957-12-10T01:54:48.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": "c4a8b9c3-42a0-23e3-3159-cb02ae6c3847",
"membership": {
"id": "eb48dda3-e9d5-291d-4ca6-41874571c48e",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "c188c6b3-d842-1583-e869-86b2de82acb4",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "698c4d39022bd401370000bc"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "nisi est tempor sed",
"can_download_receipt": false,
"amount_refunded": 5322248,
"refunded": false,
"refunds": [],
"site_id": "1b1b6e04-4e4e-6403-82a0-ff068b29b36e",
"billing_period_from": "1937-09-24",
"billing_period_to": "1946-02-08",
"processing_at": "1952-12-27T17:11:58.0Z",
"created_at": "1895-07-02T15:11:34.0Z",
"updated_at": "1959-09-18T06:13:23.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": "340fbefc-6de0-25b4-22d7-9bd9d2edc5b1",
"membership": {
"id": "0ed27c60-f36e-723d-0fec-52da178ad910",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "60d54ee4-72c3-0c0e-534e-e8bc368f10bd",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "698c4d39022bd401370000bd"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "officia anim",
"can_download_receipt": false,
"amount_refunded": 21671263,
"refunded": true,
"refunds": [
{
"id": "6441f5c9-45ba-6dc3-81b5-79a50c8ded31",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "44011cd6-e71c-2b5e-0a84-7f6cad882357",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1942-11-18T01:46:22.0Z",
"updated_at": "1959-12-12T23:01:43.0Z"
},
{
"id": "846081f9-9093-622f-4192-6d40491feedf",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "47ab988b-5c84-4ce0-e2b6-b674a16b1b78",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1897-04-02T06:52:05.0Z",
"updated_at": "1926-11-05T07:37:54.0Z"
}
],
"site_id": "a26059a9-2e5b-21e2-e1c3-3b49f9b13d47",
"billing_period_from": "1911-12-03",
"billing_period_to": "1909-05-01",
"processing_at": "1908-07-15T05:48:18.0Z",
"created_at": "1921-07-25T22:57:54.0Z",
"updated_at": "1919-12-09T11:14:36.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": "698c4d3a022bd401370000c0",
"organisation_id": "fd34a019-aac6-3431-2857-e03ff421c147",
"site_id": "064f89f8-8f16-f8fa-fe2e-01a30cc28419",
"customer_id": "aace6f9f-3f5c-c8b6-d525-519d3e9600a5",
"membership_id": "e6268891-5e4e-f122-783f-c4005dfe6449",
"from": "Trybe",
"to": "+447123456789",
"message": "amet magna aliqua et aliquip",
"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": {
"proident113": [
"dolore ex occaecat",
"Duis magna irure"
]
},
"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": "560dedc6-38db-aef5-690e-fea6db1f71e3",
"organisation_id": "e67ba7b6-2f67-0316-fd50-d762157701d2"
}
}{
"message": "The requested resource could not be found"
}