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": "4272f2bf-5624-c620-a38d-02583f57d1af",
      "site_id": "34a1b309-2228-12fd-3baf-2fe8ff86b35c",
      "customer": {
        "id": "cc6ad414-c2f1-238a-a692-23e5e38a8d49",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1896-12-23",
        "brand_id": "3a2d108f-9677-e5e4-8c60-7aee2d20589a",
        "site_id": "cb0f9e1b-84d3-12a0-1caf-f2e4811c5d4e",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "db317127-1995-2a2e-0753-51108783025b",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "e6e8b347-3732-e500-3f55-ade97fce7b0b",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "15ad69cc-231a-de25-418b-16d9d8c0f878",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "5b094b18-79cc-912f-be5b-e69af480b414",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1908-04-25T23:31:48.0Z",
        "created_at": "1934-07-27T02:50:51.0Z",
        "updated_at": "1895-03-02T02:11:43.0Z",
        "deleted_at": "1964-02-25T13:57:24.0Z",
        "last_active_at": "1908-01-01T03:43:15.0Z",
        "email_verified_at": "1946-04-14T03:05:59.0Z",
        "last_check_in": {
          "checked_in_at": "1924-01-01T09:21:54.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "ea01ccfe-2cb0-cf5c-8bfd-d3bad02c0ad9",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "exercitation ad qui Lorem Ut"
      },
      "members": [
        {
          "customer_id": "ddd73659-4273-e16a-a48f-467528df1fec",
          "membership_number": "1234567890"
        },
        {
          "customer_id": "f9986f0e-aa75-544b-597a-49ae09dfe0be"
        }
      ],
      "rate": {
        "membership_type_id": "ad5bf9e0-9c64-d993-5b07-6ee2e21271a0",
        "currency": "GBP",
        "joining_fee": 1000,
        "default_duration": "P1Y",
        "created_at": "1890-01-28T12:38:54.0Z",
        "updated_at": "1966-08-24T18:16:10.0Z"
      },
      "source": "app",
      "payment_method": {
        "id": "aliquip commodo enim veniam aute",
        "type": "card",
        "card_brand": "amex"
      },
      "start_date": "1906-09-22T07:42:17.0Z",
      "end_date": "1950-09-25T06:38:20.0Z",
      "next_billing_date": "1936-08-23T01:07:25.0Z",
      "next_charge": {
        "id": "3a2f9b9f-bf13-8944-7cdf-b61cee057c6a",
        "amount": 3995,
        "currency": "GBP",
        "status": "succeeded",
        "billing_period_from": "1947-08-31",
        "billing_period_to": "1925-01-31"
      }
    },
    {
      "site_id": "c4ea8f0f-b8aa-a46f-4b6a-676749c8074b",
      "customer": {
        "id": "f60caa68-50d0-ada0-7050-c0a811579295",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1892-03-22",
        "brand_id": "cd6416bb-3fef-f7d1-2dac-43350f867052",
        "site_id": "df0c2cbb-1a6b-e4c1-9045-a62390abff0b",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "507e7afc-7872-7e83-177e-0bd0199e5eeb",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "730497ee-a26e-1bb2-0681-c799557a9027",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "b917d0f7-4b86-5ef7-75a7-979200625a8e",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "bb60699d-2d9a-bbd0-3f29-7f901ad8de00",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "c1c0ca95-dba2-dde4-1e1d-f277d3103bd2",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1902-03-02T07:29:10.0Z",
        "created_at": "1918-06-09T09:42:23.0Z",
        "updated_at": "1962-05-14T13:58:33.0Z",
        "deleted_at": "1910-02-16T03:26:10.0Z",
        "last_active_at": "1929-03-05T01:56:59.0Z",
        "email_verified_at": "1910-05-19T14:06:50.0Z",
        "last_check_in": {
          "checked_in_at": "1966-02-20T16:58:11.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "1c027ded-c6aa-8cd2-44f7-bcb3290abd08",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "quis enim Ut"
      },
      "rate": {
        "id": "dc02d8dc-b833-5197-efc9-dfd73db87c7b",
        "membership_type_id": "176be12e-6f0c-b62c-530e-a820b58f79b7",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1955-11-23T16:43:51.0Z",
        "updated_at": "1966-09-23T21:25:56.0Z"
      },
      "source": "import",
      "payment_method": {
        "id": "Duis nisi",
        "type": "direct_debit",
        "last_4": "quis in exercitation"
      },
      "start_date": "1954-08-02T07:03:32.0Z",
      "created_at": "1930-09-15T04:01:35.0Z",
      "next_billing_date": "1928-07-21T02:55:03.0Z"
    },
    {
      "id": "464b5108-d70d-05ac-b927-4ba2a68a2a05",
      "site_id": "508bd07a-9f0d-f594-1a76-ca90e2331c97",
      "membership_number": "1234567890",
      "type": {
        "id": "f7418e20-d9c9-ff51-6a3d-a9f929f72412",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "in commodo consequat amet pariatur",
        "brand_id": "2a08a442-7171-42a8-d18e-a349e71b9be0",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": true,
        "visibility": "private",
        "minimum_start_date": "1951-03-15T01:48:39.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "membership_type_id": "2170a0be-b2c7-bcec-1651-fc3964c13c93",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "tax": 1250,
            "default_duration": "P1Y",
            "private": true
          },
          {
            "id": "d79644a9-e291-16cb-0e31-d260316759b1",
            "membership_type_id": "c6fe2cfd-0957-df4a-20f0-0bb029c1e236",
            "name": "Standard rate"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1894-10-30T20:05:35.0Z",
        "updated_at": "1917-04-25T05:54:16.0Z",
        "deleted_at": "1927-08-02T23:17:59.0Z"
      },
      "rate": {
        "id": "30eb19ed-0310-d554-c188-9146301561c3",
        "membership_type_id": "a1967fc9-f299-a3ee-3d6a-f8552483678c",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "elit commodo dolore reprehenderit cupidatat",
          "labore"
        ],
        "default_duration": "P1Y",
        "created_at": "1894-08-09T08:36:01.0Z",
        "updated_at": "1908-05-08T02:03:09.0Z"
      },
      "basket_id": "691ee37e8d439b012b000083",
      "next_billing_date": "1898-08-19T03:35:03.0Z",
      "next_charge": {
        "id": "21b80409-6562-c6f8-d3f2-f07505b23dc9",
        "amount": 3995,
        "currency": "GBP",
        "status": "errored",
        "billing_period_from": "1908-11-01",
        "billing_period_to": "1943-04-24"
      },
      "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": "14a2cbbc-485d-13b3-923f-1201d0dddc4c",
    "site_id": "de2628c6-479a-a3f3-8de6-3202d6273195",
    "membership_number": "1234567890",
    "customer": {
      "id": "a4811deb-0bd4-21ba-3775-2048f75b9a41",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1892-04-15",
      "brand_id": "40ffa0d2-8e24-b1e5-2f7f-d8f605a19bb7",
      "site_id": "07ce397a-dfd1-1d0c-6751-3a3d4fd9ef68",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "9d491b24-f6b0-27ef-393c-d636bff9e9de",
          "name": "VIP",
          "color": "ff6634"
        },
        {
          "id": "bd84b7de-c289-baae-b562-6ae7cdded771",
          "name": "VIP",
          "color": "ff6634"
        },
        {
          "id": "bb526e19-51fa-791d-1a64-3bd507bc1147",
          "name": "VIP",
          "color": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1916-09-11T22:23:49.0Z",
      "created_at": "1941-11-02T18:05:24.0Z",
      "updated_at": "1928-06-05T14:38:20.0Z",
      "deleted_at": "1922-01-28T22:55:36.0Z",
      "last_active_at": "1920-10-24T13:57:25.0Z",
      "email_verified_at": "1908-01-26T11:01:28.0Z",
      "last_check_in": {
        "checked_in_at": "1939-05-24T07:36:46.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "98582e35-65f0-95d9-6883-dbfa4a988617",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo.jpg"
      },
      "external_ref": "mollit consequat incididunt"
    },
    "members": [
      {
        "customer_id": "5f65fae1-81da-f3e7-020e-33223de9def3",
        "membership_number": "1234567890",
        "is_lead": true
      }
    ],
    "type": {
      "id": "494279f6-1e2a-ce4e-f3f1-b7a14c2cf818",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "sunt",
      "brand_id": "5bb9f9d9-bb50-8014-2941-54440f6abef8",
      "offline_payments": false,
      "disable_confirmation_email": true,
      "private": true,
      "visibility": "public",
      "minimum_start_date": "1931-08-27T09:22:39.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "id": "ba552356-ebb1-170a-e808-1921d8d639eb",
          "membership_type_id": "2a0d8839-84f7-847c-9ca4-004ea81cabdb",
          "name": "Standard rate"
        },
        {
          "id": "9cbf63e3-bf7a-c2df-d7ad-e46be8fa8db6",
          "membership_type_id": "c302f820-8480-1502-4d91-0be2d8465806",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "tax": 1250,
          "billing_frequency": "P1M",
          "processors": [
            "tempor pariatur dolor non",
            "sit nostrud voluptate ipsum qui",
            "dolor nostrud ut aute anim",
            "quis consequat dolore"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1943-04-20T06:46:42.0Z"
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1906-03-12T17:45:04.0Z",
      "updated_at": "1934-07-30T06:51:05.0Z",
      "deleted_at": "1953-09-13T04:37:40.0Z"
    },
    "status": "needs_dd_mandate",
    "source": "import",
    "payment_method": {
      "id": "et"
    },
    "start_date": "1903-11-10T01:21:02.0Z",
    "created_at": "1931-07-29T23:13:16.0Z",
    "external_ref": "anim in ad proident et",
    "next_charge": {
      "id": "f5ba056e-a2e2-5d1c-1320-27a406d52ec9",
      "amount": 3995,
      "currency": "GBP",
      "status": "pending",
      "billing_period_from": "1925-07-09",
      "billing_period_to": "1891-06-22"
    },
    "attention_reason": "payment_disputed"
  }
}
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": "11eeccaf-6803-0c9d-be82-b707854a331b",
    "membership": {
      "id": "45c6e1ac-7ce4-c9b2-b2f4-f25b5e6c7443",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "d0940f41-6629-6a5b-bc45-ad5e8fd340d3"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "691ee37e8d439b012b000084"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "Lorem deserunt fugiat eu elit",
    "can_download_receipt": true,
    "amount_refunded": "adipisicing magna",
    "refunded": "nisi",
    "refunds": [
      {
        "id": "41d21ace-8953-edae-8644-c214a9da41db",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "e4ac44f9-e1c6-b265-2d7c-c85dd0954a3a",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1900-10-25T10:47:30.0Z",
        "updated_at": "1945-10-04T19:09:22.0Z"
      },
      {
        "id": "f47f076d-8c05-e878-af57-b48f3ca5cec5",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "5669d131-578b-9697-40c8-93a90d02c299",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1952-09-23T20:01:58.0Z",
        "updated_at": "1905-03-08T22:19:34.0Z"
      },
      {
        "id": "3c332517-7b09-c375-4991-612a9461a429",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "b414c41d-dba3-913e-5423-d4ae6e5dec3d",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1941-10-02T01:03:52.0Z",
        "updated_at": "1916-08-17T14:16:32.0Z"
      },
      {
        "id": "e66c6a05-1f3d-e18a-15b0-23da9b8e44a7",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "e5c1b356-1e02-59e9-179e-d1661b09fc42",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1969-05-29T11:41:57.0Z",
        "updated_at": "1919-04-19T05:30:05.0Z"
      },
      {
        "id": "b7fd9ab2-dcc5-8217-5703-66275bec8c38",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "c749c45d-2ddb-aeb4-273f-6c25cec7f078",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1893-01-20T15:51:38.0Z",
        "updated_at": "1934-07-01T04:02:38.0Z"
      }
    ],
    "site_id": "812a0ea3-41b0-b8d3-38f1-2b12748e8f00",
    "billing_period_from": "1935-04-27",
    "billing_period_to": "1905-09-03",
    "processing_at": "1956-05-01T06:27:11.0Z",
    "created_at": "1912-04-26T08:07:25.0Z",
    "updated_at": "1931-01-25T13:58:42.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": "a256bdc5-6131-90b5-e27f-fef35ed512f9",
    "membership": {
      "id": "98744f75-1adb-c3cb-525a-020ac1b6f364",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "35be635f-9bff-2845-415c-34f911b9a543",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "691ee37e8d439b012b000085"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "sed tempor laboris et",
    "can_download_receipt": false,
    "amount_refunded": "sed occaecat ex id",
    "refunded": "eiusmod non magna consequat id",
    "refunds": [
      {
        "id": "b72487e9-2d84-56d1-ccc1-117cc1cd73b8",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "36b78f23-7abd-a3cd-eba1-60b2ce980e0a",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1894-03-02T03:41:22.0Z",
        "updated_at": "1906-10-28T18:11:47.0Z"
      },
      {
        "id": "e7bff0ff-7cc3-e68f-4e72-bef9ba580ac5",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "9ab7989d-258f-ad8e-07ed-20e94cd082d5",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1894-01-17T11:30:45.0Z",
        "updated_at": "1951-07-29T09:11:10.0Z"
      }
    ],
    "site_id": "a5c24b55-e6c1-83e2-f6e8-e6139eaccb5e",
    "billing_period_from": "1890-10-06",
    "billing_period_to": "1904-04-14",
    "processing_at": "1953-04-06T17:59:57.0Z",
    "created_at": "1943-08-25T21:55:52.0Z",
    "updated_at": "1952-03-20T12:34:01.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": "b786a5c9-3622-7dbf-b9c6-01f8c74438de",
    "membership": {
      "id": "afb4d959-c5b1-1071-05f7-24d0d6f6e7ae",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "2cdfba17-3e54-50ad-29e2-a642fa974d02",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "processor_type": "Cash",
      "processor_type_id": "691ee37e8d439b012b000086"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "enim aute consectetur",
    "can_download_receipt": true,
    "amount_refunded": "velit in",
    "refunded": "amet dolore",
    "refunds": [
      {
        "id": "611171d0-af8b-a817-b16a-c7164836bbc7",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "8abc96c1-eed1-864c-b16c-cb9162800ff7",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1949-01-28T20:42:55.0Z",
        "updated_at": "1906-06-18T23:55:23.0Z"
      },
      {
        "id": "1372c203-c2a6-5c4b-4784-05e7fe869631",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "dfc22f67-04c8-34f5-340b-7f300c46e595",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1950-11-19T01:19:17.0Z",
        "updated_at": "1911-06-15T14:38:17.0Z"
      },
      {
        "id": "3e7a22d4-77cd-363c-eaa5-740bb0d3edb0",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "bc483367-44d7-1083-bc00-e7f1f528c58c",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1957-07-24T01:42:16.0Z",
        "updated_at": "1905-04-30T02:47:04.0Z"
      },
      {
        "id": "1ac4ba70-1938-b980-6823-0a3a139183cf",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "6e156187-0436-8fdd-b63c-b9a7342d4986",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1905-10-01T06:51:22.0Z",
        "updated_at": "1894-11-25T09:17:27.0Z"
      },
      {
        "id": "c0a4beae-8be1-b672-5977-334ce850c2b5",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1932-05-19T09:26:53.0Z",
        "updated_at": "1958-08-26T14:03:54.0Z"
      }
    ],
    "site_id": "68c59791-1d70-0a14-8c5f-f82cac613ffe",
    "billing_period_from": "1903-08-29",
    "billing_period_to": "1929-02-19",
    "processing_at": "1932-04-18T10:27:12.0Z",
    "created_at": "1920-11-09T12:25:53.0Z",
    "updated_at": "1949-03-08T15:56:03.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}