Memberships

A Membership represents a membership belonging to one or more Customers.

Schema

Attributes

  • The ID of the membership

  • The ID of the site this membership belongs to

  • The 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_charge
    Nullable

    A 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

""
listMemberships

List Memberships

This endpoint lists the Memberships which are associated to the provided site.

Query parameters

  • Filters memberships belonging to the specified customer

  • page
    Optional

    The page to retrieve results from

  • per_page
    Optional

    The number of results to return per page

Responses

  • 200

    The Memberships were successfully retrieved

GET/customers/memberships
200
example response
{
  "data": [
    {
      "id": "706e46e5-8165-693a-75b3-d4a9a7d191f1",
      "site_id": "8aa1df7c-3a19-a2dd-7465-8741f80cc668",
      "membership_number": "1234567890",
      "members": [
        {
          "customer_id": "1262388e-22f6-b4e2-c9b2-62e76d4e1889",
          "membership_number": "1234567890"
        },
        {
          "customer_id": "ebee4451-11e2-f53f-c2e4-34843149310c",
          "membership_number": "1234567890"
        },
        {
          "customer_id": "8bc8ee2d-aaf7-6fd0-50ca-c0a72af18814",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "00079e88-23f7-2ea1-916c-9db2b83c0b5c",
          "membership_number": "1234567890",
          "is_lead": false
        }
      ],
      "type": {
        "id": "1eeb5800-5d93-dd90-15d6-e600c7003da5",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "laborum dolor enim elit ullamco",
        "brand_id": "d152f16c-cebc-8b4c-ba6f-1bff1aab942d",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "private",
        "minimum_start_date": "1955-10-01T08:40:48.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1945-10-11T14:26:18.0Z",
        "updated_at": "1957-06-21T05:25:56.0Z",
        "deleted_at": "1960-01-18T11:15:18.0Z"
      },
      "rate": {
        "id": "5b8a5d72-6334-22da-fcb0-1c73966a6c24",
        "membership_type_id": "5c2e6090-d1d5-f1c8-d43e-67ae93e7af9a",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "billing_frequency": "P1M",
        "default_duration": "P1Y",
        "private": true,
        "updated_at": "1898-02-23T22:48:27.0Z"
      },
      "source": "unknown",
      "start_date": "1937-01-09T02:44:04.0Z",
      "created_at": "1901-07-29T08:03:22.0Z",
      "basket_id": "6912168189eb4e0128000211",
      "external_ref": "et ex dolore Duis",
      "next_billing_date": "1908-05-08T08:06:25.0Z",
      "next_charge": {
        "id": "2100790a-5284-aa35-f0f6-aa7d8afebf4d",
        "amount": 3995,
        "currency": "GBP",
        "status": "errored",
        "billing_period_from": "1968-12-31",
        "billing_period_to": "1930-07-05"
      },
      "attention_reason": "mandate_revoked"
    },
    {
      "id": "838dda06-79cc-423b-4af8-5204257b3071",
      "membership_number": "1234567890",
      "customer": {
        "id": "1d412328-15f4-98c8-a21d-6dba3426e705",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1942-10-19",
        "brand_id": "e1685015-42b0-7206-96e7-63d28d3c7c46",
        "site_id": "2925a78c-b403-1cd5-c626-08c1f083ea98",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "67d736f2-3230-fd88-960a-c02b24fad50f",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "034e1c57-6ebe-21b4-48f6-8db12c18bd6b",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "17c740dc-2991-bbb4-daff-0a11d7ec78fa",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1947-09-30T05:48:37.0Z",
        "created_at": "1890-08-23T22:10:26.0Z",
        "updated_at": "1938-10-10T09:24:28.0Z",
        "deleted_at": "1964-04-18T03:02:57.0Z",
        "last_active_at": "1895-09-26T04:02:58.0Z",
        "email_verified_at": "1899-12-02T18:22:50.0Z",
        "last_check_in": {
          "checked_in_at": "1909-12-15T05:19:10.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "e5716bc5-29e3-70b8-a0af-dee7ac103eb1",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "cupidatat"
      },
      "members": [
        {
          "customer_id": "a32062f7-b2d0-0a85-f32c-e5daafb0303f",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "is_lead": true
        },
        {
          "customer_id": "c9361c48-db8b-0eed-de90-99e38cd97e95",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "d1e23c97-b609-b33b-5679-d94c87529d39"
        }
      ],
      "type": {
        "id": "c327fc23-a7f4-0f26-5215-81553589eced",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "veniam non exercitation et Duis",
        "brand_id": "63cc3502-63f4-fad8-7991-fca2fdf2ebf5",
        "offline_payments": false,
        "disable_confirmation_email": false,
        "private": false,
        "visibility": "private",
        "minimum_start_date": "1952-07-12T18:44:37.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "8ea0f559-9511-29c1-6d75-59abd71f5383",
            "membership_type_id": "b0bdb556-ce22-7c68-1904-674f3008e88d",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "processors": [
              "enim voluptate dolore magna sint",
              "dolore sint",
              "id",
              "laboris esse"
            ],
            "private": true,
            "created_at": "1951-06-06T20:55:46.0Z",
            "updated_at": "1951-07-19T09:30:14.0Z"
          },
          {
            "id": "876cf2ef-4b62-e2db-6915-671b5c60271a",
            "membership_type_id": "e188982e-3fd5-f765-d64e-aee2bcc4ae63",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "private": true,
            "updated_at": "1925-09-27T03:39:01.0Z"
          },
          {
            "id": "712672e7-de94-83ad-c6c1-dd1383093c10",
            "membership_type_id": "2cce8037-994e-ce17-320a-af3a622bd4e7",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1932-06-06T12:53:20.0Z",
            "updated_at": "1933-06-29T06:35:08.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1929-04-26T18:51:23.0Z",
        "updated_at": "1944-05-26T11:53:04.0Z",
        "deleted_at": "1925-02-04T11:32:11.0Z"
      },
      "rate": {
        "id": "c0df4a84-3d07-9418-7b1f-508289707d95",
        "currency": "GBP",
        "billing_frequency": "P1M"
      },
      "status": "reserved",
      "source": "app",
      "payment_method": {
        "id": "ullamco",
        "type": "card",
        "last_4": "consequat ea dolor",
        "card_brand": "amex"
      },
      "start_date": "1912-02-06T13:44:39.0Z",
      "end_date": "1957-08-29T12:27:07.0Z",
      "created_at": "1962-03-13T02:46:55.0Z",
      "basket_id": "6912168189eb4e0128000212",
      "external_ref": "Duis incididunt eiusmod aliqua consequat",
      "next_billing_date": "1939-08-27T03:52:35.0Z",
      "next_charge": {
        "id": "60f1f986-4732-a193-250a-16a8fce1c560",
        "amount": 3995,
        "currency": "GBP",
        "status": "failed",
        "billing_period_from": "1937-02-02",
        "billing_period_to": "1920-04-26"
      },
      "attention_reason": "payment_disputed"
    },
    {
      "id": "50bead41-ec1c-33a6-9158-058b10e03502",
      "site_id": "9025e8d3-ef29-db34-6368-3cb58659217b",
      "membership_number": "1234567890",
      "customer": {
        "id": "d7833f4c-6b19-11f5-389c-359f1515fca6",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1930-05-02",
        "brand_id": "a7a7852b-be8c-af95-500e-fcf396018eab",
        "site_id": "ab77ce0a-3294-8a6b-f23d-916637a4f646",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "e4c84ba0-d467-28c7-00c8-08b5bfe88440",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "fd7c9b9f-4f8d-605c-7ff9-e698d652a5d9",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1938-07-03T17:01:10.0Z",
        "created_at": "1968-04-21T15:19:32.0Z",
        "updated_at": "1967-11-21T15:16:56.0Z",
        "deleted_at": "1967-01-16T01:11:33.0Z",
        "last_active_at": "1906-04-01T03:05:45.0Z",
        "email_verified_at": "1925-06-13T04:21:39.0Z",
        "last_check_in": {
          "checked_in_at": "1935-10-09T05:25:18.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "16fb66b5-0512-6997-ac45-d9a5d8478a6e",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "nisi fugiat ea anim"
      },
      "members": [],
      "type": {
        "id": "dab9ab51-ce15-7e24-17b0-6f6200936b83",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "adipisicing in non",
        "brand_id": "de03b6be-fc6f-4f7d-7a19-458ceed4260d",
        "offline_payments": false,
        "disable_confirmation_email": false,
        "private": false,
        "visibility": "link_only",
        "minimum_start_date": "1907-07-18T01:04:22.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "b2433182-813f-a330-7ae9-ed6399fd4796",
            "membership_type_id": "195b8f6d-dfae-0020-56cc-d40e34bc3935",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "veniam proident fugiat laboris ut",
              "aliqua ullamco velit",
              "in dolor magna anim",
              "id"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1966-12-22T12:31:48.0Z",
            "updated_at": "1929-03-24T15:20:50.0Z"
          },
          {
            "membership_type_id": "2fbbf14a-8298-76b1-9c27-33e6a85f6ab5",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "private": true
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1917-07-13T09:39:01.0Z",
        "updated_at": "1897-04-15T12:53:41.0Z",
        "deleted_at": "1904-09-08T04:47:32.0Z"
      },
      "rate": {
        "id": "59e45db5-c978-fd95-d57a-e61cbf3697e9",
        "membership_type_id": "d476537b-c212-f9f9-0868-c96a19173ab4",
        "billing_frequency": "P1M",
        "processors": [
          "est irure amet proident",
          "reprehenderit minim",
          "non ea Ut ad",
          "cillum culpa"
        ],
        "private": true
      },
      "status": "needs_dd_mandate",
      "source": "app",
      "payment_method": {
        "id": "culpa aliqua nostrud",
        "last_4": "qui enim ut dolore",
        "status": "revoked"
      },
      "start_date": "1924-11-09T21:10:40.0Z",
      "end_date": "1956-12-05T14:39:45.0Z",
      "created_at": "1923-11-15T05:20:45.0Z",
      "basket_id": "6912168189eb4e0128000213",
      "external_ref": "esse Duis",
      "next_billing_date": "1929-09-16T06:18:16.0Z",
      "next_charge": {
        "id": "e70bea75-b245-155c-630e-a00cd41a0750",
        "amount": 3995,
        "currency": "GBP",
        "status": "pending",
        "billing_period_from": "1924-07-14",
        "billing_period_to": "1915-01-20"
      },
      "attention_reason": "mandate_revoked"
    }
  ],
  "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"
  }
}
getMembership

Show a membership

Use this endpoint to retrieve a Membership by its ID.

Path parameters

Responses

  • 200

    The Membership was successfully retrieved

  • 404

    The resource couldn't be found

GET/customers/memberships/{membershipId}
200
example response
{
  "data": {
    "id": "b9751964-738a-616f-ce5b-5388c3360ee1",
    "site_id": "86bce2dd-94d7-5889-7919-539b3973dd58",
    "membership_number": "1234567890",
    "customer": {
      "id": "cadc530a-7550-f30c-cf5b-36be26cc802f",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1968-02-16",
      "brand_id": "64ff5056-89b6-a503-6717-7a17c3c98391",
      "site_id": "c795ff65-cc91-8831-d0f8-062c9e0ac945",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [],
      "preferred_locale": "en",
      "locked_at": "1893-02-27T01:09:43.0Z",
      "created_at": "1907-10-25T07:25:01.0Z",
      "updated_at": "1922-07-17T20:36:31.0Z",
      "deleted_at": "1947-08-13T16:56:03.0Z",
      "last_active_at": "1964-06-10T13:41:33.0Z",
      "email_verified_at": "1943-02-19T13:51:44.0Z",
      "last_check_in": {
        "checked_in_at": "1905-02-24T16:08:41.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "82f73d9f-ddc7-957d-caef-31ae9679f47d",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo.jpg"
      },
      "external_ref": "magna proident nostrud sit"
    },
    "members": [
      {
        "customer_id": "d96ce86f-e3b5-6c0c-a456-40ab8f777148",
        "membership_number": "1234567890"
      }
    ],
    "type": {
      "id": "14c37c4f-ccb2-cf7a-5c95-f2f46b68d774",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "minim culpa adipisicing laboris occaecat",
      "brand_id": "00ca5a8d-85c3-c3a5-a2c6-9d5ca2b78889",
      "offline_payments": false,
      "disable_confirmation_email": true,
      "private": false,
      "visibility": "public",
      "minimum_start_date": "1925-04-22T09:32:25.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1901-10-21T05:02:06.0Z",
      "updated_at": "1939-09-15T23:11:19.0Z",
      "deleted_at": "1960-06-02T10:21:52.0Z"
    },
    "rate": {
      "id": "f307ac1d-7d57-9b59-3177-35ce79ce2fb2",
      "membership_type_id": "513639ac-9f0d-c0b6-0bac-543c1d62250b"
    },
    "status": "upcoming",
    "source": "import",
    "payment_method": {
      "id": "est non eu amet cillum",
      "type": "direct_debit",
      "last_4": "mollit veniam minim Excepteur"
    },
    "start_date": "1946-05-05T16:07:07.0Z",
    "end_date": "1904-09-13T01:41:05.0Z",
    "created_at": "1958-08-08T03:01:21.0Z",
    "basket_id": "6912168189eb4e0128000214"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}
actionAddMembershipChargePayment

Record a manual payment against a charge

This endpoint allows a manual (off-Trybe) payment to be recorded against a membership charge.

Path parameters

Request body

  • The ID of the custom payment type this payment should be recorded as

  • amount
    Required

    The amount of the payment

Responses

  • 200

    A charge against a membership.

  • 404

    The resource couldn't be found

POST/shop/membership-charges/{chargeId}/payment
200
example response
{
  "data": {
    "id": "8311b37c-3b01-d561-11e3-2eec30f9272b",
    "membership": {
      "id": "ca01a4b2-12ce-54f8-fddf-8e0fc20a8edb",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "f685d664-06c5-1067-63eb-f00ed67a1395",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type_id": "6912168189eb4e0128000215"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "sit est",
    "can_download_receipt": true,
    "amount_refunded": "in do occaecat dolor",
    "refunded": "reprehenderit anim irure occaecat nostrud",
    "refunds": [
      {
        "id": "f0f526a2-0c1d-babb-9c41-f3fa829ef19d",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "d53d8946-10c4-dc5c-8b2b-3cfa50c33d49",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1910-04-20T08:58:32.0Z",
        "updated_at": "1890-08-22T22:14:37.0Z"
      },
      {
        "id": "06026871-ca63-492a-5911-e3c866d947b5",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "71116b62-46d6-25b6-a800-cad7f5e56861",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1915-02-17T01:45:01.0Z",
        "updated_at": "1967-03-31T16:16:50.0Z"
      }
    ],
    "site_id": "3a882737-e6d6-933a-4688-8904e76bfaa0",
    "billing_period_from": "1962-02-16",
    "billing_period_to": "1896-07-28",
    "processing_at": "1910-12-17T10:37:40.0Z",
    "created_at": "1952-01-12T15:52:55.0Z",
    "updated_at": "1914-07-09T07:03:30.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}
actionProcessMembershipCharge

Manually process a charge for a membership

This endpoint allows a membership charge to be processed manually.

Path parameters

Responses

  • 200

    A charge against a membership.

  • 404

    The resource couldn't be found

POST/shop/membership-charges/{chargeId}/process
200
example response
{
  "data": {
    "id": "61348403-8ee0-5bc9-ac2f-99269a56649e",
    "membership": {
      "id": "0e394574-c423-3f83-cc0c-fa77be1e81a5",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "e5bec003-9c97-fc88-67ca-160306ae9e5d",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type_id": "6912168189eb4e0128000216"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "sed in dolor",
    "can_download_receipt": false,
    "amount_refunded": "irure",
    "refunded": "ut aliqua anim et",
    "refunds": [],
    "site_id": "2dbd728d-26e6-2f60-dc50-f189c9922191",
    "billing_period_from": "1915-05-02",
    "billing_period_to": "1916-05-30",
    "processing_at": "1928-10-19T17:51:11.0Z",
    "created_at": "1890-03-05T17:27:05.0Z",
    "updated_at": "1937-10-04T11:35:16.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}
actionRetryMembershipCharge

Manually retry a charge for a membership

This endpoint allows a membership charge to be retried manually.

Path parameters

Responses

  • 200

    A charge against a membership.

  • 404

    The resource couldn't be found

POST/shop/membership-charges/{chargeId}/retry
200
example response
{
  "data": {
    "id": "694506c8-4c23-7686-7694-970ab92a653d",
    "membership": {
      "id": "624874be-e213-cae0-55ac-836829f398f0",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "814fdfa8-d4e9-80bb-7c1f-41015adfd9d2",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "6912168189eb4e0128000217"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "in sed",
    "can_download_receipt": true,
    "amount_refunded": "nostrud in velit laborum laboris",
    "refunded": "Lorem amet sit",
    "refunds": [
      {
        "id": "bc5a2451-a419-3cc1-1525-87c065ef1904",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "5d47769c-7c82-9305-51ca-2d06564268cc",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1911-12-20T07:14:31.0Z",
        "updated_at": "1919-05-12T16:13:44.0Z"
      },
      {
        "id": "5fc9ce60-2d97-44ed-3183-02e5c69f71b9",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "88c361e5-6640-0ab9-e28d-174bd359890f",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1951-10-29T18:43:29.0Z",
        "updated_at": "1953-12-04T12:26:55.0Z"
      },
      {
        "id": "dc1d1f4e-d643-9c6c-b7b3-fbcf332274b8",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "707ed496-da90-537d-e31c-8c2a40e630a5",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1953-05-15T10:38:41.0Z",
        "updated_at": "1964-06-04T02:02:57.0Z"
      }
    ],
    "site_id": "d85c77a9-e8fb-e6b9-c4c1-72411b5efd30",
    "billing_period_from": "1910-10-25",
    "billing_period_to": "1902-02-07",
    "processing_at": "1941-12-04T19:18:18.0Z",
    "created_at": "1923-08-09T06:17:44.0Z",
    "updated_at": "1890-01-29T13:34:21.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}