A Membership represents a membership belonging to one or more Customers.
The ID of the membership
The ID of the site this membership belongs to
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.
Possible values are active, needs_dd_mandate, needs_attention, reserved, inactive, expired and upcoming
Where the membership was created
Possible values are self_signup, app, import and unknown
Details 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 date which the membership starts
The date which the membership ends
The datetime which the membership was created
The basket ID which was used to purchase this membership, if applicable.
An external reference for this membership.
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.
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
""listMembershipsThis endpoint lists the Memberships which are associated to the provided site.
The Memberships were successfully retrieved
{
"data": [
{
"id": "cb4121ab-b707-b97b-e2d6-c465c25f93f8",
"site_id": "e2e39c60-2612-d41b-4379-dc16501c2f49",
"membership_number": "1234567890",
"customer": {
"id": "2324aa3c-730a-2ca8-5e69-f0820729606f",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1922-05-24",
"brand_id": "fe413b6c-34bf-e681-fc0c-e2e959baf8e3",
"site_id": "93cf88ed-517f-67e7-63a7-6f618ba0a3cd",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "17589e92-a771-0760-de88-02a0efc3e074",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "5b742ea5-ea60-8033-ddd8-3f1efcc9df5c",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "b6926578-57ac-6ec4-aa88-ff40def2a3fb",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "34da92a4-b5d5-54a8-a34f-27dc37610a22",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "23467423-6aa6-f5c3-b1cd-d8c2dc820698",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1961-03-07T17:28:46.0Z",
"created_at": "1949-07-05T17:13:40.0Z",
"updated_at": "1912-08-18T08:21:36.0Z",
"deleted_at": "1967-11-29T08:09:31.0Z",
"last_active_at": "1916-05-18T23:35:24.0Z",
"email_verified_at": "1896-05-19T10:11:09.0Z",
"last_check_in": {
"checked_in_at": "1909-02-08T07:06:54.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "497d16f1-5593-46be-5fd6-fc0a6ef732d2",
"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": "sunt nulla ut dolor"
},
"members": [
{
"customer_id": "b9373061-67a2-229e-8b4e-70c2e62687c9",
"membership_number": "1234567890",
"is_lead": false
}
],
"type": {
"id": "9ec3ba1b-6b7c-ad10-b6e6-11f9c323d249",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "magna aute",
"brand_id": "4ab60309-79fb-c6ec-6d78-2aff7b97bdac",
"offline_payments": false,
"disable_confirmation_email": false,
"private": false,
"visibility": "private",
"minimum_start_date": "1938-01-18T14:05:07.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "688bfe64-eda5-3d2e-9255-3a930401c0d0",
"membership_type_id": "3813905c-7782-fcd7-4ef7-959baeaf9992",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"sed",
"pariatur sed eiusmod",
"laborum cillum voluptate non",
"consectetur ex qui ad id",
"occaecat sunt enim elit"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1926-12-14T07:02:54.0Z",
"updated_at": "1903-10-26T23:10:54.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1947-05-04T01:30:39.0Z",
"updated_at": "1962-04-07T04:21:44.0Z",
"deleted_at": "1900-12-24T11:30:58.0Z"
},
"rate": {
"id": "87e7b3bb-7e58-4782-3aaf-bc9a5d85256d",
"membership_type_id": "22cabeea-18e8-1133-fa89-e669f453cf7a",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut reprehenderit quis",
"consectetur culpa ullamco ea sunt"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1930-10-19T18:21:08.0Z",
"updated_at": "1906-09-04T04:18:56.0Z"
},
"status": "needs_attention",
"source": "import",
"start_date": "1953-04-02T08:01:18.0Z",
"end_date": "1912-10-15T22:14:52.0Z",
"created_at": "1910-06-06T22:47:17.0Z",
"basket_id": "698369288e299e012b0000aa",
"external_ref": "Excepteur dolor quis nisi",
"next_billing_date": "1892-01-16T02:55:45.0Z",
"next_charge": {
"id": "6d2c7bdb-8b9d-93e4-7975-ba88ff62292e",
"amount": 3995,
"currency": "GBP",
"status": "failed",
"billing_period_from": "1955-08-07",
"billing_period_to": "1945-07-01"
},
"attention_reason": "payment_disputed"
},
{
"id": "3b14a086-3ae1-aa92-52b6-970dbbf63a88",
"site_id": "379fab35-8891-3679-3a29-daabd357cc3f",
"membership_number": "1234567890",
"customer": {
"id": "82089a70-e48f-a887-bddc-580eeb334122",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1948-08-01",
"brand_id": "0e7cf02d-78cf-79d0-0b51-758638680cc2",
"site_id": "a7292db9-1d2c-4a50-6e9e-0e13f918cdaa",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "3c0e1103-529b-3493-41cc-65eaf23dec04",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "b0f8a26f-c5fc-1677-485b-8adb1c359561",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "ccfea24f-f1da-0455-f3f2-898343ef8d87",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "4a830d02-baa0-bf51-28c7-e82ab616a97b",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "621ae1aa-24fd-0bbc-6b4d-f9a61139b84d",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1910-07-18T01:35:50.0Z",
"created_at": "1917-02-08T05:44:12.0Z",
"updated_at": "1939-05-11T14:27:41.0Z",
"deleted_at": "1900-02-22T09:01:07.0Z",
"last_active_at": "1914-01-22T17:27:10.0Z",
"email_verified_at": "1966-05-04T14:55:54.0Z",
"last_check_in": {
"checked_in_at": "1912-11-27T16:44:51.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "40be8a51-373f-b1a8-07f2-b7ead9af4b4f",
"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": "ad sit sint"
},
"members": [
{
"customer_id": "eb22ff58-a4ee-90e1-811f-521aae823697",
"membership_number": "1234567890",
"is_lead": false
}
],
"type": {
"id": "1161456f-406f-3c3c-16b0-6d07313d8d9d",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "officia laboris esse do sed",
"brand_id": "8ef9fbb7-969e-8c13-b615-49b67b08671f",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1906-12-24T20:25:01.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "5205bb9e-cda6-af72-e6dc-1315764323b5",
"membership_type_id": "55fa6bef-bcb5-3ee9-6318-22ac5c898f64",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut aliquip",
"exercitation",
"ut anim",
"quis fugiat adipisicing est",
"anim"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1906-10-14T17:37:31.0Z",
"updated_at": "1942-07-15T03:30:22.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1916-06-30T06:38:28.0Z",
"updated_at": "1966-07-19T03:28:47.0Z",
"deleted_at": "1923-03-08T16:24:03.0Z"
},
"rate": {
"id": "ac041645-e369-9202-e664-21c10a12d857",
"membership_type_id": "60b8a4e6-1639-9d15-5401-fe3360635978",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"veniam Duis ea cillum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1908-12-09T23:11:01.0Z",
"updated_at": "1893-10-12T01:14:24.0Z"
},
"status": "needs_dd_mandate",
"source": "self_signup",
"payment_method": {
"type": "direct_debit",
"last_4": "in eiusmod dolore magna",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1940-10-14T08:01:32.0Z"
},
{
"id": "665e2805-0beb-1604-7173-98afe8134ae1",
"site_id": "a688f262-f928-ea3e-4d86-c7639efed72c",
"membership_number": "1234567890",
"customer": {
"id": "f5f80030-e808-6890-d081-09099bfc4396",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1953-03-25",
"brand_id": "11d8529d-7f13-8bec-af2c-cb21a3131aa2",
"site_id": "b529a8c1-1dda-a687-d4ff-5c3ca1b892c1",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "4e2d1ebc-ef11-ddae-fe96-ccb44ca00a27",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "f9e974c8-99d4-9778-357b-f30afd553999",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1938-06-09T17:30:08.0Z",
"created_at": "1951-11-12T20:50:38.0Z",
"updated_at": "1896-06-06T20:03:17.0Z",
"deleted_at": "1898-08-18T18:01:16.0Z",
"last_active_at": "1947-12-05T01:28:58.0Z",
"email_verified_at": "1945-05-13T16:18:54.0Z",
"last_check_in": {
"checked_in_at": "1919-05-28T23:15:54.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "e74fa482-1832-68a8-8dd7-4b85fb7ff175",
"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": "sunt sit velit quis commodo"
},
"members": [
{
"customer_id": "42e0facb-28f1-6989-18ee-2f7072c87632",
"is_lead": false
},
{
"customer_id": "edb5197e-4ee0-5965-b9a5-ccb9ae0c4af3",
"membership_number": "1234567890",
"is_lead": false
},
{
"customer_id": "86a174f2-982e-9d67-701a-d60f29b49cc7",
"membership_number": "1234567890"
}
],
"type": {
"id": "6783f8ce-cb30-efb8-1872-98a9eb556f6d",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "exercitation labore deserunt laborum Ut",
"brand_id": "dbe92112-bb16-2c7d-6a1a-ebea961832e8",
"offline_payments": false,
"disable_confirmation_email": false,
"private": true,
"visibility": "link_only",
"minimum_start_date": "1941-08-04T01:55:10.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "03034ffd-4234-246e-b113-ac308f4b96be",
"membership_type_id": "f32fd914-dcab-0e91-08cb-5d466c7eb15e",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"voluptate",
"anim in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1900-02-26T01:10:49.0Z",
"updated_at": "1950-03-22T04:24:49.0Z"
},
{
"id": "c0645f27-d186-4421-6dbb-4931dd8ecce2",
"membership_type_id": "6ec1d9e2-6593-592d-0dbe-59252951df8e",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"elit veniam nisi enim",
"cupidatat ex esse quis"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1911-06-23T09:05:10.0Z",
"updated_at": "1926-11-09T02:59:31.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1955-06-12T14:57:41.0Z",
"updated_at": "1943-12-18T17:20:06.0Z",
"deleted_at": "1942-05-02T11:49:26.0Z"
},
"rate": {
"id": "5fb1072c-d994-b8a5-595f-24c4c8d76f48",
"membership_type_id": "d7b86ffb-322a-0840-5135-e054585a29eb",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1917-02-14T19:09:29.0Z",
"updated_at": "1961-09-16T03:53:12.0Z"
},
"status": "active",
"source": "import",
"payment_method": {
"status": "revoked"
},
"start_date": "1931-04-18T01:13:39.0Z",
"end_date": "1892-05-18T23:56:14.0Z",
"created_at": "1918-04-10T12:05:45.0Z",
"basket_id": "698369288e299e012b0000ab",
"external_ref": "velit",
"next_billing_date": "1935-10-28T06:18:47.0Z",
"attention_reason": "no_mandate"
},
{
"id": "8dbed2f1-8f23-9702-9596-1be252123627",
"site_id": "6c0d277f-5257-b322-004b-71015542ea1e",
"membership_number": "1234567890",
"customer": {
"id": "18dd1e6c-5e79-747a-86db-7c38b4287927",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1910-01-17",
"brand_id": "fe926e30-6571-5208-5222-75635955d2ad",
"site_id": "cceeb7db-1d9a-295e-9fc8-429d489c8ae3",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [],
"preferred_locale": "en",
"locked_at": "1919-09-08T12:46:10.0Z",
"created_at": "1903-05-31T21:47:43.0Z",
"updated_at": "1899-11-06T07:29:28.0Z",
"deleted_at": "1895-11-22T06:23:10.0Z",
"last_active_at": "1909-07-21T09:32:05.0Z",
"email_verified_at": "1906-09-05T07:14:33.0Z",
"last_check_in": {
"checked_in_at": "1966-11-05T12:29:17.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "9c285072-1ff3-6dd6-0c1d-7a719586ed7b",
"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 non ea"
},
"members": [
{
"customer_id": "2ba2e80f-6878-ff53-d596-b8ea4e14449a",
"membership_number": "1234567890",
"is_lead": false
},
{
"customer_id": "6e3ffb14-1e12-25ca-e65b-87432be24f14",
"membership_number": "1234567890"
},
{
"customer_id": "d2157ff1-fa61-4664-72ad-7a83c91f1224"
},
{
"customer_id": "1b9c0ac9-83b0-c479-1597-018cb8a2531b",
"membership_number": "1234567890",
"is_lead": true
}
],
"type": {
"id": "f1d2663f-8cde-9106-5dd2-59233cf8a320",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "nisi officia minim voluptate proident",
"brand_id": "f76981ce-50c6-fa2b-d49e-c5de6a10803c",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "private",
"minimum_start_date": "1953-10-25T04:34:22.0Z",
"min_members": 2,
"max_members": 4,
"rates": [],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1918-11-17T11:25:33.0Z",
"updated_at": "1937-04-19T04:24:40.0Z",
"deleted_at": "1906-02-19T12:48:36.0Z"
},
"rate": {
"id": "b5f6490b-1d56-3d9b-c450-b4197685ffb9",
"membership_type_id": "0b08b9c5-1d96-aba3-73ae-606445c98670",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-03-02T12:34:49.0Z",
"updated_at": "1927-03-14T11:17:43.0Z"
},
"status": "needs_attention",
"source": "self_signup"
},
{
"id": "f179ed26-819b-23e8-dfc2-efeeb79ab086",
"site_id": "ddf5b13b-2c43-38d2-f571-c91505cf369b",
"membership_number": "1234567890",
"customer": {
"id": "b3688deb-c645-911d-d37c-99bfe638bbd9",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1906-11-04",
"brand_id": "b1125218-0602-a26b-2636-41ca888eb77e",
"site_id": "56dce6ad-e2b9-9a0a-cad3-0c37bc80a610",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "9fefb854-c03f-556b-6fef-bc93cbf18816",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "b4a68383-fc60-67d3-62cd-66cb2a7e3517",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "6bbf77db-ee73-a9f0-3039-3ebd72210594",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "ebb2af4f-aeb1-da07-34aa-d3069aa738c4",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1921-03-22T11:31:13.0Z",
"created_at": "1950-04-20T04:59:24.0Z",
"updated_at": "1895-10-23T11:24:29.0Z",
"deleted_at": "1910-02-18T09:29:23.0Z",
"last_active_at": "1960-11-26T14:59:39.0Z",
"email_verified_at": "1963-01-01T04:32:12.0Z",
"last_check_in": {
"checked_in_at": "1967-05-23T04:53:46.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "2903eee9-ab5a-ce15-3da5-45b93a823d32",
"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": "deserunt exercitation eu aute"
},
"members": [],
"type": {
"id": "5f092b3b-0b1d-399d-25e2-12673a0ee4ca",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "eiusmod pariatur do elit incididunt",
"brand_id": "49d8228a-0f63-f508-3553-afe1d6b21e04",
"offline_payments": false,
"disable_confirmation_email": true,
"private": true,
"visibility": "public",
"minimum_start_date": "1943-11-18T21:10:05.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "74a3625a-7495-e839-9f61-42aa8382df5c",
"membership_type_id": "f2b6c9a2-0a33-c932-1601-c4e39d1606cb",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1932-01-13T01:42:46.0Z",
"updated_at": "1893-01-13T14:47:34.0Z"
},
{
"id": "14587e90-0b18-0065-d2ec-785fd8a6b0b0",
"membership_type_id": "e772206b-dd0e-232a-54d1-d29cba3d2f42",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ad ipsum et",
"sint labore culpa"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1961-09-19T22:19:01.0Z",
"updated_at": "1946-06-10T15:39:09.0Z"
},
{
"id": "8d732077-7d68-df98-b413-87ba6af3575d",
"membership_type_id": "650fe694-1cfd-8123-d4b9-0230b9148045",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1925-05-16T19:48:53.0Z",
"updated_at": "1907-12-17T19:55:27.0Z"
},
{
"id": "9a3435a3-79ba-ed84-757c-3356eab5b053",
"membership_type_id": "01c5f2d4-3eee-9f41-9e67-16b63ec1ca73",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"aliquip",
"ipsum cupidatat consequat dolore exercitation"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1955-03-17T18:51:21.0Z",
"updated_at": "1967-09-20T23:56:25.0Z"
},
{
"id": "b89eefe0-f061-dd8c-c174-65c839833884",
"membership_type_id": "3304b8ef-9506-95f5-0fc1-c68ab8cc6903",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1945-06-11T20:25:22.0Z",
"updated_at": "1928-04-30T02:28:04.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1926-05-07T09:24:19.0Z",
"updated_at": "1903-10-09T10:03:47.0Z",
"deleted_at": "1911-08-24T10:34:12.0Z"
},
"rate": {
"id": "d25e7968-326d-00ed-53f0-a543c3ecae61",
"membership_type_id": "bf2ca739-aef7-a87b-1e2e-a017958b6201",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut Ut",
"magna aliqua"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1969-09-21T23:07:26.0Z",
"updated_at": "1966-02-23T19:07:46.0Z"
},
"status": "active",
"source": "self_signup",
"payment_method": {
"id": "in velit qui",
"type": "card",
"last_4": "do tempor",
"status": "revoked",
"card_brand": "amex"
}
}
],
"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": "a029a77e-0a75-39b5-d99f-7f24643739bf",
"site_id": "50df626b-8f75-9fdb-63c6-25aeb6f42c45",
"membership_number": "1234567890",
"customer": {
"id": "b9489f8b-a2ae-9b63-47c1-b2cce765f6d7",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1954-02-10",
"brand_id": "ae254626-d0f4-05a1-5647-567403432894",
"site_id": "28238f7b-6ae0-05bd-728e-e1599b3de2ae",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "cb55c673-620a-3c39-9d57-9532dd1644ab",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "9fc0dabf-8ef0-92d9-0757-7c546a7ce38f",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "206095ea-f10e-0718-6259-3722351df7ea",
"value": "VIP",
"colour": "ff6634"
},
{
"id": "bc8559e3-34a7-b7e9-e3d8-1478cc1e7870",
"value": "VIP",
"colour": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1968-06-25T10:59:11.0Z",
"created_at": "1940-08-03T07:50:11.0Z",
"updated_at": "1904-01-10T09:21:01.0Z",
"deleted_at": "1935-10-29T15:10:15.0Z",
"last_active_at": "1941-11-01T01:35:36.0Z",
"email_verified_at": "1927-07-13T05:18:55.0Z",
"last_check_in": {
"checked_in_at": "1939-08-07T09:47:59.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "27c8df9c-b405-8f34-3181-1f684cbd4fbf",
"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 cillum"
},
"members": [
{
"customer_id": "b341f59e-98ab-5b98-b030-8c7d530caa69",
"membership_number": "1234567890",
"is_lead": false
}
],
"type": {
"id": "2f786557-dff7-d78a-c319-dfec8d39de82",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "non quis enim laboris",
"brand_id": "82b408f7-1057-3e11-0258-5e9b01d427c0",
"offline_payments": true,
"disable_confirmation_email": false,
"private": true,
"minimum_start_date": "1907-03-07T08:16:19.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "cac69a16-e4b2-934a-4d7e-85a5c4412634",
"membership_type_id": "e3f20c28-25a5-254c-b65f-e98162e45ffc",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"exercitation ullamco"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-05-07T03:11:59.0Z",
"updated_at": "1953-07-21T06:56:19.0Z"
},
{
"id": "530865cc-1adf-f5bc-7491-af8fedd0d779",
"membership_type_id": "63f50a38-fcd5-88a0-1df6-bdd9385de9b5",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"laborum dolor sunt culpa Ut",
"veniam labore in in irure"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-01-29T08:06:02.0Z",
"updated_at": "1940-01-14T01:42:24.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1890-08-14T09:38:07.0Z",
"updated_at": "1907-11-09T22:03:17.0Z",
"deleted_at": "1893-06-19T13:08:52.0Z"
},
"rate": {
"id": "55c20fdd-e2c1-4328-c2b3-acbaf189b8f9",
"membership_type_id": "739941c8-15ad-e9e3-d71f-8d692be27fd6",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1957-01-10T20:53:25.0Z",
"updated_at": "1933-09-18T12:42:14.0Z"
},
"status": "upcoming",
"source": "self_signup",
"payment_method": {
"type": "card",
"card_brand": "amex"
},
"start_date": "1948-08-06T22:50:48.0Z",
"basket_id": "698369288e299e012b0000ac",
"attention_reason": "payment_outstanding"
}
}{
"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": "f7da7750-7707-4e72-8512-b0bbd847f2a4",
"membership": {
"id": "eba8a76b-0cf8-1f58-4aff-e9a775c65522",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "b6699769-140c-f200-bc21-9b96e5769097"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "698369288e299e012b0000ad"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "labore",
"can_download_receipt": true,
"amount_refunded": -69877844,
"refunded": true,
"refunds": [
{
"id": "1120334d-adc9-c733-063a-760f73e65a82",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "e3798a3c-4cbf-7be7-0d97-d6bab0514d8a",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1945-12-31T15:08:08.0Z",
"updated_at": "1916-09-21T02:30:15.0Z"
},
{
"id": "6041df7b-e162-6ba3-e225-f42dde8aaead",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "9d26e1ec-b4d7-e49d-373e-14642ab1be21",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1961-08-20T05:31:01.0Z",
"updated_at": "1900-09-19T02:41:39.0Z"
},
{
"id": "cd9c8ca0-a639-79c4-2c8e-a7527eeee954",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1928-11-14T11:08:31.0Z",
"updated_at": "1932-10-21T02:41:35.0Z"
}
],
"site_id": "e4d96759-e2f3-f2f1-c511-536ff302ae13",
"billing_period_from": "1900-04-10",
"billing_period_to": "1891-08-18",
"processing_at": "1921-03-08T10:33:39.0Z",
"created_at": "1905-09-03T10:11:16.0Z",
"updated_at": "1916-12-05T03:22:20.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": "15640221-1a4b-7e7d-3f6d-b71c15ce0117",
"membership": {
"id": "d3cbf68a-861c-2736-649f-b79f7985f755",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "73f3c0f5-07b4-85e5-dfcf-20811a2ce31e",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type_id": "698369288e299e012b0000ae"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "officia anim",
"can_download_receipt": true,
"amount_refunded": 74801673,
"refunded": false,
"refunds": [
{
"id": "42873f40-1f48-c307-037f-2767f9527c45",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1921-09-24T09:09:52.0Z",
"updated_at": "1950-10-20T13:44:13.0Z"
},
{
"id": "86b5dea7-df10-569d-0c73-5556159f04e6",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "45ee904e-65b4-0049-97b7-4fd802df3ecb",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1911-04-13T22:13:01.0Z",
"updated_at": "1950-02-04T23:26:15.0Z"
},
{
"id": "dee2d0e9-6aaa-5737-662b-4ef9aa291c2d",
"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": "1930-07-03T14:32:52.0Z",
"updated_at": "1911-02-07T08:12:23.0Z"
}
],
"site_id": "be9a9dab-60f6-822a-33b2-1a8daabd4e39",
"billing_period_from": "1894-01-14",
"billing_period_to": "1947-04-22",
"processing_at": "1924-06-29T20:12:44.0Z",
"created_at": "1914-06-07T02:20:05.0Z",
"updated_at": "1944-10-22T06:50:14.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": "0f9ae04b-b84f-c224-3d5d-465c06389f6e",
"membership": {
"id": "404cdfcd-256c-8ddf-6779-ef24956a0fd9",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "04b46761-e536-63fb-9a94-418f78bd0762",
"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": "ex esse",
"can_download_receipt": false,
"amount_refunded": 35508831,
"refunded": false,
"refunds": [
{
"id": "a8bf4a3e-9f18-de6b-dad8-e43f4bc64f99",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "7d8cd584-1e32-fab5-1050-c905cd8a3cc6",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1907-10-13T16:18:42.0Z",
"updated_at": "1928-06-24T22:09:49.0Z"
},
{
"id": "047679b5-f238-ac1e-d999-e098933e6cfb",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "d79dc77b-ba88-3159-7e51-0fc9c43cd543",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1965-04-17T19:17:44.0Z",
"updated_at": "1934-06-17T20:37:51.0Z"
}
],
"site_id": "f68af164-5add-fccd-520a-4d900325144f",
"billing_period_from": "1951-03-17",
"billing_period_to": "1926-05-06",
"processing_at": "1899-07-09T01:04:57.0Z",
"created_at": "1940-05-20T05:18:34.0Z",
"updated_at": "1927-03-26T01:26:23.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": "698369288e299e012b0000af",
"organisation_id": "97f3379d-55bb-09a5-ca7a-261b778938c3",
"site_id": "be8e9d78-f096-ff76-aa5c-c3f773513b0f",
"customer_id": "8717ff8d-04af-b1be-7eb3-ea4f23dd6d0f",
"from": "Trybe",
"to": "+447123456789",
"message": "dolor",
"message_type": "billing_details_request",
"message_delivered": true,
"created_at": "2024-02-02T12:01:01.0Z"
}
}{
"message": "The requested resource could not be found"
}{
"errors": {
"qui_f79": [
"et",
"dolore laborum Lorem cupidatat adipisicing",
"dolore",
"reprehenderit"
],
"veniam15c": [
"quis labore amet",
"dolore aliquip ex",
"mollit"
]
},
"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": "311c3cba-c045-2bca-0fa0-1824857658d8",
"organisation_id": "7a86c4be-0be4-8706-1170-6547954102b5"
}
}{
"message": "The requested resource could not be found"
}