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": "0c90e1a5-2874-6843-073d-50f89aac5579",
"site_id": "54101089-bb0c-6b29-82aa-dbe8c95ec65c",
"membership_number": "1234567890",
"customer": {
"id": "e04261cc-b3c7-49d9-95d2-0a0245a1aa53",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1965-09-22",
"brand_id": "1792fcc1-6162-7eed-335d-5f9b336b155b",
"site_id": "b06eea20-9443-ddf2-07c2-b74f2e74bbe6",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "acdf3c16-e01a-aa92-e36e-cc345035b7dd",
"name": "VIP",
"color": "ff6634"
},
{
"id": "b2a7d64e-a48d-0741-5480-1df8d280210d",
"name": "VIP",
"color": "ff6634"
},
{
"id": "c396bedc-97cc-7d69-7d3f-544163469aba",
"name": "VIP",
"color": "ff6634"
},
{
"id": "b9347139-3423-dbdf-8fe4-07a99ae3789e",
"name": "VIP",
"color": "ff6634"
},
{
"id": "4e1096fd-9a15-fda6-eead-1f3b44ab36aa",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1949-08-20T17:53:42.0Z",
"created_at": "1948-02-19T12:21:16.0Z",
"updated_at": "1950-12-24T18:32:24.0Z",
"deleted_at": "1907-10-14T12:05:40.0Z",
"last_active_at": "1928-03-19T12:15:38.0Z",
"email_verified_at": "1965-06-09T21:06:32.0Z",
"last_check_in": {
"checked_in_at": "1956-02-26T16:15:54.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "6a4f83ef-e5ea-6c0f-2662-538e437c259b",
"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": "cillum culpa ullamco ea quis"
},
"members": [
{
"customer_id": "25296b34-82d1-3b16-c244-bf2a5eb1434f",
"membership_number": "1234567890"
}
],
"type": {
"id": "ba276cfd-c216-ccb4-4a98-31c38c519efe",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "eu",
"brand_id": "dddb0c9e-1ccb-7468-ca3d-0d31b5e988a7",
"offline_payments": true,
"disable_confirmation_email": false,
"private": true,
"visibility": "public",
"minimum_start_date": "1894-04-08T19:08:42.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "1444716b-769c-6d2d-e10f-c4e9ce7fa1b9",
"membership_type_id": "2e7fa82a-f912-8c34-c444-320ea901604c",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [],
"default_duration": "P1Y",
"private": true,
"created_at": "1896-04-07T05:39:15.0Z",
"updated_at": "1897-05-20T04:22:33.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1957-09-29T14:02:40.0Z",
"updated_at": "1918-01-10T01:30:14.0Z",
"deleted_at": "1927-04-19T19:25:46.0Z"
},
"rate": {
"id": "27a59a3f-658e-e164-fdfd-402cba594a66",
"membership_type_id": "9a62db92-e3d0-623b-74cb-a775c555bff0",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ut amet ullamco sint sed",
"nisi voluptate aliquip pariatur in",
"est sunt",
"aliquip voluptate"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1968-04-05T16:59:14.0Z",
"updated_at": "1905-12-22T06:48:02.0Z"
},
"status": "inactive",
"source": "app",
"payment_method": {
"id": "laborum aliqua exercitation enim adipisicing",
"type": "card",
"last_4": "laboris nisi",
"status": "revoked"
},
"start_date": "1968-01-31T08:38:26.0Z",
"end_date": "1917-07-02T16:03:29.0Z",
"created_at": "1946-09-09T16:09:29.0Z",
"basket_id": "6979fadbf5130b011d0000ac",
"external_ref": "Excepteur eu consequat aliqua sed",
"attention_reason": "payment_outstanding"
},
{
"membership_number": "1234567890",
"type": {
"id": "e586cd29-3f5c-a292-21e1-2d7ec13883dd",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "aliquip minim",
"brand_id": "2e6e6461-0e99-79fc-a159-efe6a4db5978",
"offline_payments": true,
"disable_confirmation_email": true,
"private": false,
"visibility": "public",
"minimum_start_date": "1968-02-04T01:38:37.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "e6a2f3b4-4cad-7959-cde4-7c4e8d15679a",
"membership_type_id": "4ef11a89-e977-3647-3d7c-169750506236",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"tempor exercitation",
"eiusmod ut irure anim",
"dolore",
"eu in"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1952-12-31T17:15:44.0Z",
"updated_at": "1959-06-05T19:23:51.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1960-08-06T07:51:58.0Z",
"updated_at": "1969-06-28T07:34:12.0Z",
"deleted_at": "1899-08-28T06:11:42.0Z"
},
"rate": {
"id": "a4808740-1e2e-c8c5-4bb4-783d9f5bcf1b",
"membership_type_id": "694746fb-f41c-e49b-e5cf-fd7f98c05949",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"qui"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1916-10-13T03:14:05.0Z",
"updated_at": "1912-09-15T04:12:17.0Z"
},
"status": "reserved",
"source": "app",
"payment_method": {
"id": "non ut laboris incididunt",
"type": "direct_debit",
"last_4": "dolore dolore",
"card_brand": "amex"
},
"start_date": "1954-08-15T06:32:50.0Z",
"created_at": "1945-12-28T01:20:38.0Z",
"basket_id": "6979fadbf5130b011d0000ad",
"next_billing_date": "1946-01-13T14:33:45.0Z",
"next_charge": {
"id": "20169c6d-4936-fc43-0d4b-d7f2ac2f8bbf",
"amount": 3995,
"currency": "GBP",
"status": "succeeded",
"billing_period_from": "1940-11-13",
"billing_period_to": "1932-09-15"
},
"attention_reason": "no_mandate"
}
],
"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": "b35ca1bb-97f9-abea-cef8-e9161ba2b563",
"site_id": "09622821-8964-66cd-9072-84c8ecac00ad",
"membership_number": "1234567890",
"customer": {
"id": "c9618a15-7e1a-fc7b-fe6f-ff8716dba608",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"phone": "+447900000000",
"has_password": true,
"dob": "1927-10-19",
"brand_id": "a6023567-2558-6c07-796a-790a54a0bc62",
"site_id": "638d0192-462e-1984-16e8-9791812198ed",
"stripe_id": "cus_1234567890",
"express_stripe_id": "cus_1234567890",
"email": "janedoe@example.com",
"labels": [
{
"id": "32220c8e-1b9a-d71d-8a86-34a6282390d1",
"name": "VIP",
"color": "ff6634"
},
{
"id": "cb0809e7-1280-d005-37ad-1eb35caa7256",
"name": "VIP",
"color": "ff6634"
},
{
"id": "4e81cc68-4647-393f-7ac8-620c68e34f1b",
"name": "VIP",
"color": "ff6634"
},
{
"id": "f5ff381d-5c8f-4581-2fbe-94c526dda95b",
"name": "VIP",
"color": "ff6634"
}
],
"preferred_locale": "en",
"locked_at": "1965-06-14T07:48:43.0Z",
"created_at": "1927-08-19T12:24:04.0Z",
"updated_at": "1903-06-17T02:48:01.0Z",
"deleted_at": "1948-08-31T10:57:44.0Z",
"last_active_at": "1934-10-24T09:05:21.0Z",
"email_verified_at": "1962-06-28T06:29:12.0Z",
"last_check_in": {
"checked_in_at": "1925-10-22T11:29:41.0Z",
"method": "Scanned"
},
"avatar_id": "000000-000000-000000-000000",
"avatar": {
"id": "ed7971ba-c840-26c5-b57e-5498d6b3f0f1",
"file_name": "super-cool-photo.jpg",
"mime_type": "image/jpeg",
"original_url": "https://example.com/media/super-cool-photo.jpg",
"size": 84256,
"url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
},
"external_ref": "sit incididunt"
},
"members": [
{
"customer_id": "0406c679-5769-4957-b654-6d92a9ec24ee",
"membership_number": "1234567890",
"is_lead": false
},
{
"customer_id": "23d376df-fd5d-d5af-516f-e5a76dcfa85f"
},
{
"customer_id": "94aaadcd-0b8a-3237-7e62-b30631cac9f8",
"membership_number": "1234567890",
"is_lead": true
},
{
"customer_id": "d9184697-23b4-eed8-4cd3-d5000386d11b",
"is_lead": true
},
{
"customer_id": "29edc7be-0b3f-0448-1636-051462f1a6a9",
"membership_number": "1234567890"
}
],
"type": {
"id": "9ee5ea15-93bb-ee81-6100-864b746adc40",
"name": "Gold tier",
"description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
"terms": "in cillum aute",
"brand_id": "fee4ec53-f540-9541-97cc-67405a0f3970",
"offline_payments": true,
"disable_confirmation_email": false,
"private": false,
"visibility": "link_only",
"minimum_start_date": "1896-08-02T05:23:28.0Z",
"min_members": 2,
"max_members": 4,
"rates": [
{
"id": "95dbc843-68a0-bfb3-b00b-a3065d3f4a57",
"membership_type_id": "6d7c7ca1-c710-e2df-2ec6-25be7f041718",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"cupidatat in dolore irure",
"minim Lorem",
"ad in deserunt",
"sunt ex dolore"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1925-05-19T02:42:18.0Z",
"updated_at": "1933-01-28T06:12:53.0Z"
},
{
"id": "9f2eceea-0020-b6d5-9442-27435e525dcf",
"membership_type_id": "b6224701-4816-d0e4-e16c-7de3866ff428",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"nulla consequat quis",
"nulla"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1913-01-21T20:43:36.0Z",
"updated_at": "1892-05-28T02:34:58.0Z"
},
{
"id": "9833cd80-ef9e-689d-3afd-14dcfbd338e6",
"membership_type_id": "c9c6fed6-487e-eca4-9a17-c19d04ef3d95",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"ullamco sint quis ex",
"sed eiusmod amet reprehenderit",
"ex aliqua dolor velit proident",
"ut laboris",
"culpa laborum"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1891-12-11T08:23:06.0Z",
"updated_at": "1942-04-13T05:01:35.0Z"
}
],
"revenue_schedule": "FREQ=WEEKLY",
"created_at": "1965-03-23T17:41:55.0Z",
"updated_at": "1909-03-16T13:22:31.0Z",
"deleted_at": "1910-09-20T03:57:55.0Z"
},
"rate": {
"id": "079d565b-13c6-fd2b-e7cf-a093b16fbaed",
"membership_type_id": "b17c4a1a-b5f1-923b-fce0-c0ba725b3150",
"name": "Standard rate",
"currency": "GBP",
"price": 5000,
"joining_fee": 1000,
"billing_frequency": "P1M",
"processors": [
"consectetur",
"aliqua eu",
"proident"
],
"default_duration": "P1Y",
"private": true,
"created_at": "1897-03-23T13:46:02.0Z",
"updated_at": "1912-12-30T04:59:41.0Z"
},
"status": "expired",
"source": "import",
"payment_method": {
"id": "qui",
"type": "direct_debit",
"status": "revoked",
"card_brand": "amex"
},
"start_date": "1927-05-30T18:41:55.0Z",
"end_date": "1905-02-03T04:12:16.0Z",
"created_at": "1958-06-11T09:17:51.0Z",
"external_ref": "in esse consectetur Excepteur ut",
"next_charge": {
"id": "91746437-8ddd-a212-a76f-7d68e05ce0b7",
"amount": 3995,
"currency": "GBP",
"status": "errored",
"billing_period_from": "1931-06-17",
"billing_period_to": "1937-10-12"
}
}
}{
"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": "5c7d77b5-e6ce-005d-2195-2d8f32ee8f12",
"membership": {
"id": "2841ae5f-6ae4-dbda-719e-367f688dbbf1",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "65134297-12eb-e853-a65d-92a86dd29a72",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type_id": "6979fadbf5130b011d0000ae"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "voluptate dolor",
"can_download_receipt": true,
"amount_refunded": -59733321,
"refunded": false,
"refunds": [
{
"id": "3d96f9e5-5e8a-e3d8-afae-f6d8ee88da73",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "f1dea8d6-a28d-107e-4f91-2b2412886754",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1891-01-30T07:15:11.0Z",
"updated_at": "1935-08-14T16:26:16.0Z"
},
{
"id": "c47ff24e-01aa-579e-4ddb-7d46a31c19ee",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "06046727-2047-ab9c-c23d-cc44ed8ef1a0",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1941-09-09T21:36:22.0Z",
"updated_at": "1906-06-22T19:46:03.0Z"
},
{
"id": "af786e36-1a9e-d6d1-9417-1a318d56ed01",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "0c75bdac-1dfd-35fe-4c48-b71498c391cb",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1906-12-05T12:02:58.0Z",
"updated_at": "1917-10-04T19:41:34.0Z"
},
{
"id": "cc9f1b8a-ea58-0ad1-75f9-67a17d025134",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "376b2841-a5b2-22e2-d11d-bbf2c8f2a3d0",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1921-01-10T14:35:41.0Z",
"updated_at": "1948-03-05T21:04:51.0Z"
}
],
"site_id": "75b747cf-d271-da99-ffac-5d96e15a18fe",
"billing_period_from": "1953-01-05",
"billing_period_to": "1923-05-17",
"processing_at": "1900-08-09T10:48:59.0Z",
"created_at": "1909-03-15T16:58:52.0Z",
"updated_at": "1948-01-14T13:13:58.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": "c1b67cfc-8c60-18cb-2dfd-054bb60cd83e",
"membership": {
"id": "135cca34-d646-9e1f-11b5-318cb9d1de59",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "54480069-32dc-2ec6-c6ef-2c141f888699",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"processor_type": "Cash",
"processor_type_id": "6979fadbf5130b011d0000af"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "est",
"can_download_receipt": true,
"amount_refunded": -56492735,
"refunded": true,
"refunds": [
{
"id": "2d1e3ef4-9b62-87f7-6d49-bbca3f348160",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "19d06a76-1bbc-7624-8e59-1974e0d43f2c",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1895-02-04T10:20:59.0Z",
"updated_at": "1935-01-27T19:17:58.0Z"
},
{
"id": "c8471584-dfd6-90bb-d83c-e03132830efa",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "3c6f8237-9186-31f7-3387-7b416a8ba44a",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1969-12-06T04:22:19.0Z",
"updated_at": "1909-05-14T13:02:28.0Z"
},
{
"id": "aff86fb7-1026-27e6-7fab-569443a00c72",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "3fd6ab1b-a6f8-f11b-6a87-dc9e11eae5a6",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1916-06-29T01:06:44.0Z",
"updated_at": "1936-09-01T06:11:09.0Z"
},
{
"id": "7cb31c17-23cf-757a-6b03-6dbbd2c0ac64",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "83f5a8db-e168-e171-e977-d4853e6cd8d3",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1927-11-20T12:46:56.0Z",
"updated_at": "1917-06-10T07:14:23.0Z"
},
{
"id": "c3469ea3-c2f9-7c28-7260-26134e6746df",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "9b74da94-6933-591d-d327-1149b9e57ee7",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1940-08-03T11:20:11.0Z",
"updated_at": "1961-10-10T15:53:15.0Z"
}
],
"site_id": "72d8f57c-07e8-845a-cdf5-54e549bee052",
"billing_period_from": "1919-07-05",
"billing_period_to": "1911-03-16",
"processing_at": "1920-05-09T17:13:57.0Z",
"created_at": "1891-02-01T18:46:34.0Z",
"updated_at": "1959-12-11T02:25:45.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": "dc134ccd-9ae4-c936-b7d9-84ce860188b6",
"membership": {
"id": "3569ce44-5239-5bae-b0d0-c1356f70a52d",
"membership_number": "00000014",
"type_name": "Gold Membership",
"customer_id": "311b0cb3-17b7-e9f0-839e-8f0297d6eac1",
"customer_name": "Jane Jones"
},
"processor": "adyen",
"processor_data": {
"cardholder_name": "Mrs J Jones",
"last_4": 4001,
"processor_type": "Cash",
"processor_type_id": "6979fadbf5130b011d0000b0"
},
"amount": 3995,
"original_amount": 3995,
"currency": "gbp",
"tax": 1000,
"status": "succeeded",
"description": "magna cupidatat ut in nostrud",
"can_download_receipt": false,
"amount_refunded": -21618975,
"refunded": true,
"refunds": [
{
"id": "986e40bb-7388-12e7-cd91-162ee5a95b48",
"status": "succeeded",
"amount": 995,
"currency": "gbp",
"notes": "Gesture of good will",
"failure_reason": "invalid_details",
"refunded_by": {
"id": "7d01e9bc-8fac-17a5-92f3-e8e55a57b1f5",
"full_name": "Jane Jenkins"
},
"processor_data": {
"processor": "adyen",
"processor_id": "re_64301e0b2df9d11814010ea6"
},
"created_at": "1950-09-03T21:07:31.0Z",
"updated_at": "1950-11-17T22:01:53.0Z"
}
],
"site_id": "4778063d-4c8b-9a66-1d10-4c1ab902d2c0",
"billing_period_from": "1913-11-28",
"billing_period_to": "1912-12-29",
"processing_at": "1904-09-30T20:45:12.0Z",
"created_at": "1928-10-14T09:59:56.0Z",
"updated_at": "1896-07-09T05:51:34.0Z"
}
}{
"message": "The requested resource could not be found"
}createMembershipSmsThis endpoint sends an SMS message to a membership's lead member. Currently supports sending billing details request messages.
membershipIdThe ID of the membership
message_typeThe type of message to send.
Possible values are billing_details_request
If true, send the SMS even if the membership already has a payment method. Defaults to false.
{
"data": {
"id": "6979fadbf5130b011d0000b1",
"organisation_id": "b1b0607a-2753-fb3f-98cd-0d0da54a6f10",
"site_id": "cd815d49-4f83-2ba0-bd38-a414b5c3b584",
"customer_id": "573fd3cb-7da0-7ee7-6736-e68170996e6d",
"membership_id": "36f6bb0c-ff81-25f6-1503-c02ead7e5368",
"from": "Trybe",
"to": "+447123456789",
"message": "qui reprehenderit cupidatat dolor consectetur",
"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": {
"qui_bd": [
"non labore aliquip in",
"ut occaecat Excepteur",
"aliquip sunt magna non"
],
"eiusmod1e3": [
"laboris quis veniam sint anim"
],
"sunt_7": [],
"non_8d": [
"aliqua dolore sit",
"sunt ut occaecat elit",
"cupidatat",
"non ex et esse commodo"
],
"sint_b": [
"sunt aliquip dolore labore mollit",
"nostrud in adipisicing",
"ea"
]
},
"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": "0f5ab77f-4953-9974-dac5-050b191244ff",
"organisation_id": "7dfe132c-441b-b203-b529-e057cb9ecdeb"
}
}{
"message": "The requested resource could not be found"
}