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": "725222b3-c8aa-958b-e255-a37a9cadf94b",
      "site_id": "45030b18-7061-1615-234e-3416006df65e",
      "membership_number": "1234567890",
      "customer": {
        "id": "b4f1fdd7-d1e2-2ccf-2148-26b3017df945",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1935-03-08",
        "brand_id": "fcd32278-7d8d-4128-7d95-b441c49593e7",
        "site_id": "a5f3afd9-3a55-e3df-28cb-649c36001d1e",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "c6c16182-833a-b801-55b8-310624a20256",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "9b806532-b2a2-f613-4226-ae38470c807f",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "6621681f-8fc6-3edc-8f94-d1a87ac8840f",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "72368d23-f19e-4ac5-cd21-be437638f377",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1940-09-06T10:47:49.0Z",
        "created_at": "1896-01-16T08:33:25.0Z",
        "updated_at": "1938-12-13T19:54:34.0Z",
        "deleted_at": "1894-12-13T05:14:57.0Z",
        "last_active_at": "1952-07-13T19:35:19.0Z",
        "email_verified_at": "1939-07-10T06:34:38.0Z",
        "last_check_in": {
          "checked_in_at": "1969-04-14T13:21:34.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "1f2ae789-bfd4-17b1-c789-3d1beeb5c729",
          "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": "labore proident irure magna commodo"
      },
      "members": [
        {
          "customer_id": "99d734e2-ae67-5a85-ca5e-0e8903ad77d9",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "a65735da-58d9-50da-73c1-97f79759e684",
          "membership_number": "1234567890"
        }
      ],
      "type": {
        "id": "00cc9b6a-601e-937f-e827-e32544a331cf",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "ea in anim adipisicing",
        "brand_id": "5f55ef62-1cca-ff42-0a1a-a787b3662883",
        "offline_payments": true,
        "disable_confirmation_email": false,
        "private": true,
        "visibility": "public",
        "minimum_start_date": "1896-02-10T14:18:37.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "6aede9f9-5781-547f-c2a4-f1f481c0d68a",
            "membership_type_id": "e77ba87c-1259-2e74-8dae-435112030496",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "ex do"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1956-12-13T05:39:38.0Z",
            "updated_at": "1938-07-14T16:09:51.0Z"
          },
          {
            "id": "87896bbc-7d29-3a44-ecb8-a2ddffac6834",
            "membership_type_id": "98a24bfd-9741-9045-c684-8fb57e81480e",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1947-05-22T20:38:36.0Z",
            "updated_at": "1945-08-23T02:58:16.0Z"
          },
          {
            "id": "fe9d0a85-e4b6-8c3a-e619-c9a80ac57f72",
            "membership_type_id": "92e70fea-5100-77a4-b543-694a2bb08b86",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "aliqua et laborum in",
              "officia tempor ea et"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1948-09-30T13:58:48.0Z",
            "updated_at": "1919-12-14T19:45:47.0Z"
          },
          {
            "id": "66c9a926-5082-1da8-9c8a-3623d9a53e6a",
            "membership_type_id": "71875012-7925-03c7-a1c2-9b3dad9c5e35",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "dolore",
              "ipsum",
              "laboris nulla dolor dolor"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1956-09-02T18:06:20.0Z",
            "updated_at": "1934-06-17T01:10:06.0Z"
          },
          {
            "id": "76ec1078-32c4-bd38-4dcb-abe68a4cb255",
            "membership_type_id": "8a7cdd7b-c894-d4df-03aa-dcb08de452f1",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "tempor",
              "nulla ea sit nostrud"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1916-08-26T05:49:11.0Z",
            "updated_at": "1918-06-29T05:36:26.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1914-10-17T09:34:03.0Z",
        "updated_at": "1907-07-19T08:01:12.0Z",
        "deleted_at": "1913-10-27T18:59:08.0Z"
      },
      "rate": {
        "id": "f3bbe071-514b-9aca-0f38-7b36d8b887e2",
        "membership_type_id": "0cd3f778-d725-b586-bb2e-6064b73e0e6f",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "processors": [
          "in"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1904-12-03T11:34:31.0Z",
        "updated_at": "1906-08-07T19:40:29.0Z"
      },
      "status": "inactive",
      "source": "self_signup"
    }
  ],
  "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": "bfe834c3-4f8a-a5ee-c143-235d57aaf02a",
    "membership_number": "1234567890",
    "customer": {
      "id": "fc943e3d-57db-1bf2-a4f6-02eeb1a3674a",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1926-11-22",
      "brand_id": "e98e5101-c5b6-6d64-1651-6dba75711201",
      "site_id": "9ad6aed4-9b26-fe9e-5dd3-3afbdb04ff90",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "f9dc81fc-a576-edce-59a3-41c7cb681768",
          "name": "VIP",
          "color": "ff6634"
        },
        {
          "id": "76ce7cbd-3ade-bae2-ac35-a519cccfccf5",
          "name": "VIP",
          "color": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1893-08-20T07:03:40.0Z",
      "created_at": "1903-02-02T11:55:50.0Z",
      "updated_at": "1958-09-23T19:17:39.0Z",
      "deleted_at": "1965-07-08T20:40:46.0Z",
      "last_active_at": "1950-02-19T08:15:28.0Z",
      "email_verified_at": "1932-12-22T02:01:21.0Z",
      "last_check_in": {
        "checked_in_at": "1920-01-26T15:20:54.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "2caceaf0-6244-5db8-7eb2-1ceb741f8ed8",
        "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": "voluptate non velit"
    },
    "members": [
      {
        "membership_number": "1234567890",
        "is_lead": true
      },
      {
        "customer_id": "1f602560-817c-9431-56f2-ee1d2384ce6d",
        "membership_number": "1234567890",
        "is_lead": true
      },
      {
        "customer_id": "815f50cb-32e5-52e4-9744-a49f34ee8976",
        "membership_number": "1234567890",
        "is_lead": false
      }
    ],
    "type": {
      "id": "499e2eee-d8f0-7830-30f2-58d2e0ab7d3e",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "ex ut labore",
      "brand_id": "aaef0b84-c112-656e-6082-2412b24c54ae",
      "offline_payments": false,
      "disable_confirmation_email": true,
      "private": true,
      "visibility": "private",
      "minimum_start_date": "1916-09-05T06:31:39.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "id": "98a352c0-e1c8-35d7-2663-0cb29a752e79",
          "membership_type_id": "f9ea8e69-82ed-59ef-5299-a73b4c39a56d",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "processors": [
            "velit fugiat anim",
            "in veniam"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1914-02-19T23:13:40.0Z",
          "updated_at": "1968-12-17T20:06:38.0Z"
        },
        {
          "id": "53023eeb-ef2a-62ca-7e7e-2f8f03d3177b",
          "membership_type_id": "18e2145a-6772-049d-a7b6-66459a2d135b",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "processors": [
            "Ut magna",
            "anim",
            "cillum mollit dolore"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1903-12-04T11:16:46.0Z",
          "updated_at": "1899-02-16T11:28:52.0Z"
        },
        {
          "id": "45419f23-4461-1842-e2d5-5140b19d502c",
          "membership_type_id": "af5b60e3-f5fa-11c1-1d8e-ae17c26446b2",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "processors": [
            "qui amet",
            "ut aute",
            "ullamco aliquip aute et",
            "ad officia incididunt",
            "eu dolor ipsum sed"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1904-06-11T07:10:23.0Z",
          "updated_at": "1899-02-04T01:11:23.0Z"
        },
        {
          "id": "bdf3b311-b2cb-c1b5-3a47-7b09ffa43ea0",
          "membership_type_id": "6a744422-6abd-5995-6c41-20a23ebe1326",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "processors": [
            "ullamco adipisicing sit sed",
            "consectetur",
            "cillum laborum minim"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1914-12-04T07:07:14.0Z",
          "updated_at": "1941-07-04T13:05:04.0Z"
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1957-08-02T16:44:24.0Z",
      "updated_at": "1939-06-16T01:01:23.0Z",
      "deleted_at": "1940-05-31T08:20:03.0Z"
    },
    "rate": {
      "id": "6afe2721-dd12-d072-f4ea-ca9901877788",
      "membership_type_id": "6d948488-2eb5-8703-5f13-d7b66b02eb5b",
      "name": "Standard rate",
      "currency": "GBP",
      "price": 5000,
      "joining_fee": 1000,
      "billing_frequency": "P1M",
      "processors": [
        "exercitation mollit"
      ],
      "default_duration": "P1Y",
      "private": true,
      "created_at": "1965-07-18T12:55:49.0Z",
      "updated_at": "1902-08-15T05:50:09.0Z"
    },
    "status": "reserved",
    "source": "app",
    "payment_method": {
      "id": "amet",
      "status": "revoked",
      "card_brand": "amex"
    },
    "start_date": "1890-07-06T01:24:54.0Z",
    "end_date": "1950-10-31T08:45:43.0Z",
    "created_at": "1911-07-04T06:06:58.0Z",
    "basket_id": "6957a928b26de901240000a1",
    "next_billing_date": "1917-10-07T23:16:06.0Z",
    "next_charge": {
      "id": "f3faeec7-6369-da43-270d-0256c44eea56",
      "amount": 3995,
      "currency": "GBP",
      "status": "failed",
      "billing_period_from": "1901-07-30",
      "billing_period_to": "1902-09-14"
    }
  }
}
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
    Nullable

    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": "2a65649c-c635-5da9-0a6b-5eb5e175d94b",
    "membership": {
      "id": "9a089972-c8d8-3309-e59e-215346fa4875",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "1d9c5986-8daf-800c-906d-1d7926d3d1e7",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "6957a928b26de901240000a2"
    },
    "amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "aliquip dolore ea et minim",
    "can_download_receipt": false,
    "amount_refunded": 31914764,
    "refunded": true,
    "refunds": [
      {
        "id": "0b1f580a-e076-497f-bd7b-41edcb194192",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "c7f02c60-0223-b9a9-b2b0-7464435c6201",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1913-03-31T01:01:28.0Z",
        "updated_at": "1944-02-22T17:27:01.0Z"
      },
      {
        "id": "d6744cd7-6443-d130-4b44-c74d937ca472",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1919-05-19T01:33:42.0Z",
        "updated_at": "1909-06-02T05:17:26.0Z"
      },
      {
        "id": "7d84621e-9ddc-2faf-03c0-a4f497e5c8da",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "8ffbc7c9-6023-8cf3-a587-ddbc4267dddf",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1917-12-07T01:08:59.0Z",
        "updated_at": "1913-01-07T05:35:06.0Z"
      },
      {
        "id": "33f140d6-1251-d65d-0995-a859c76ad421",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "0ea4a89d-eb93-e943-544a-a7355bfd42b8",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1932-05-06T04:28:01.0Z",
        "updated_at": "1947-08-11T05:28:45.0Z"
      }
    ],
    "site_id": "32b90c4b-b487-a17c-4b49-c67f7b809a5a",
    "billing_period_from": "1938-08-12",
    "billing_period_to": "1960-11-01",
    "created_at": "1909-05-25T09:01:26.0Z",
    "updated_at": "1950-06-21T19:52:09.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": "e7b77440-6cee-b457-6dd4-9bf4c43de763",
    "membership": {
      "id": "0ea30ec8-8ac5-6fef-b747-da16564c5d48",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "576f966d-2184-3b33-9620-3af0dea31976",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "processor_type": "Cash",
      "processor_type_id": "6957a928b26de901240000a3"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "deserunt",
    "can_download_receipt": false,
    "amount_refunded": 28198089,
    "refunded": false,
    "refunds": [
      {
        "id": "74c59897-ca12-b6bd-5309-596a2eac791f",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "d77300b7-0346-7f7f-fae9-f72c86ea3e34",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1946-02-22T19:32:32.0Z",
        "updated_at": "1906-05-27T04:25:06.0Z"
      },
      {
        "id": "1f46c79f-e289-558b-16a7-79e98beb11a8",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "a8a4c4d1-3444-ed26-9b97-c86045213422",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1956-03-29T01:17:01.0Z",
        "updated_at": "1962-06-11T16:09:41.0Z"
      },
      {
        "id": "c20416b8-4b51-742a-83ad-2140fe4b9a6c",
        "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": "1911-01-31T17:26:01.0Z",
        "updated_at": "1892-01-01T15:31:49.0Z"
      },
      {
        "id": "6b4415d8-2f32-5059-c62b-47cd06cce1d7",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "2bae7bf8-0d70-4024-bf68-f5cdb2b5bc99",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1965-01-23T20:15:43.0Z",
        "updated_at": "1936-05-19T01:31:05.0Z"
      }
    ],
    "site_id": "165eb936-18fc-a33c-00aa-e41775141c8b",
    "billing_period_from": "1939-03-25",
    "billing_period_to": "1965-08-19",
    "processing_at": "1940-05-16T01:24:35.0Z",
    "created_at": "1947-06-17T01:51:58.0Z",
    "updated_at": "1933-09-03T17:35:06.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": "f9e1bd1b-0cb3-3cb7-7904-fc864c4cd6a8",
    "membership": {
      "id": "19016769-2163-1021-acef-58224b85991b",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "3c50c12b-b0c4-909e-173c-de8ff70e8099"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "6957a928b26de901240000a4"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "do",
    "can_download_receipt": false,
    "amount_refunded": 26532241,
    "refunded": false,
    "refunds": [
      {
        "id": "89e39a15-4f9d-f6df-dca6-4368844101b8",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "1d9e8695-33f1-ea8b-e856-7c0ce0fdf775",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1954-03-28T02:51:48.0Z",
        "updated_at": "1907-11-16T01:56:49.0Z"
      },
      {
        "id": "d0c00629-0d81-393e-de95-93e57cf3ed1f",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "485d11fe-7347-b97b-0573-92fa62862ab6",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1938-07-13T02:26:21.0Z",
        "updated_at": "1959-05-08T06:20:20.0Z"
      },
      {
        "id": "877ca5a8-37ec-4507-1ad0-80d4275cbe1e",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "61adb2b4-0f92-8ca8-c26b-df19fa637920",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1949-04-18T10:58:55.0Z",
        "updated_at": "1891-01-06T20:35:51.0Z"
      },
      {
        "id": "72ff1499-89f4-afec-0d7e-3318d0de5dd4",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "ddd4f40c-6f63-bc51-df41-6e701942c65e",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1904-09-10T01:31:58.0Z",
        "updated_at": "1952-10-19T03:54:20.0Z"
      },
      {
        "id": "6e204c20-bb04-1c38-fd14-6577dee18746",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "c1a32c1f-c7a1-6428-5a7e-c2dd85fc26fb",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1944-10-13T22:28:39.0Z",
        "updated_at": "1931-09-19T17:46:52.0Z"
      }
    ],
    "site_id": "f7944af9-ce18-311f-f8ec-9bb1fe0171b7",
    "billing_period_from": "1903-08-02",
    "billing_period_to": "1920-06-24",
    "processing_at": "1944-07-29T20:20:22.0Z",
    "created_at": "1912-06-29T16:06:26.0Z",
    "updated_at": "1956-09-06T12:33:08.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}