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": "92edba5c-c881-4ebd-aa3a-048dccf16564",
      "site_id": "2e5c2bf2-cb4f-c08c-0f69-42706f9dd40a",
      "membership_number": "1234567890",
      "customer": {
        "id": "79f05209-f2e9-5c32-443e-f07f8f6ed4c6",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1930-03-12",
        "brand_id": "4b8420b5-e420-7b5d-b13f-054566359b55",
        "site_id": "d7f47a18-6e0e-6110-a0a7-5c682721b08d",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "b14c3f24-71c6-52d2-ca01-a714b6cd600a",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1919-09-04T02:38:21.0Z",
        "created_at": "1967-06-01T06:25:31.0Z",
        "updated_at": "1938-08-14T22:41:18.0Z",
        "deleted_at": "1893-09-30T01:54:03.0Z",
        "last_active_at": "1894-07-30T18:01:25.0Z",
        "email_verified_at": "1894-08-16T14:39:44.0Z",
        "last_check_in": {
          "checked_in_at": "1957-11-09T09:19:25.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "acdaceb6-755d-4f05-1ac5-d430fdd21b5a",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "consectetur sunt ullamco velit laborum"
      },
      "members": [
        {
          "customer_id": "a154abfc-1e06-78b3-1e25-db25ba7b85da",
          "membership_number": "1234567890",
          "is_lead": true
        }
      ],
      "type": {
        "id": "fa630a79-38a4-8c46-c7cb-58cf2693a573",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "est",
        "brand_id": "01117135-02b3-941d-c880-a704e7d0100e",
        "offline_payments": true,
        "disable_confirmation_email": true,
        "private": true,
        "visibility": "private",
        "minimum_start_date": "1958-04-26T02:18:28.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "created_at": "1903-02-01T18:19:29.0Z",
            "updated_at": "1965-12-24T01:09:55.0Z"
          },
          {
            "id": "7f49698c-1477-6496-cf44-07a5df55389d",
            "membership_type_id": "9f38b24b-3256-dae5-7e1d-520dbc76dd61"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1946-02-14T04:48:18.0Z",
        "updated_at": "1941-10-11T01:03:50.0Z",
        "deleted_at": "1966-08-23T21:36:45.0Z"
      },
      "rate": {
        "id": "c05e6cad-8623-9571-0fe6-e9f42af49d30",
        "membership_type_id": "e3480362-6142-056f-fb55-1727148d1e95",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "quis nulla laboris",
          "enim",
          "laborum dolore nisi",
          "dolor ipsum sit reprehenderit"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1935-12-20T12:55:43.0Z",
        "updated_at": "1891-06-03T12:45:01.0Z"
      },
      "source": "app",
      "payment_method": {
        "id": "ut in voluptate mollit",
        "type": "direct_debit",
        "last_4": "in",
        "card_brand": "amex"
      },
      "start_date": "1954-02-03T11:51:47.0Z",
      "end_date": "1957-05-13T10:30:55.0Z",
      "created_at": "1954-04-26T04:59:36.0Z",
      "basket_id": "688ba2beefe07e01610000a2",
      "external_ref": "nostrud incididunt Lorem",
      "next_billing_date": "1941-07-05T12:55:08.0Z",
      "next_charge": {
        "id": "096d73f4-0752-9623-43cc-0debb5eef660",
        "amount": 3995,
        "currency": "GBP",
        "status": "processing",
        "billing_period_from": "1892-06-01",
        "billing_period_to": "1890-12-26"
      },
      "attention_reason": "payment_failed"
    },
    {
      "id": "98cdcfd3-aaf6-f0f1-2a1a-6aca11e9f295",
      "site_id": "feafc391-9896-eee8-99ed-bb6786afaec0",
      "membership_number": "1234567890",
      "customer": {
        "id": "5f62088b-750d-294e-3ae9-4f429cc7557e",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1945-09-05",
        "brand_id": "b75df4be-f446-992c-c97a-4740bab32b62",
        "site_id": "1cf5bdc2-3181-0e61-2abc-1b93ba1ad7d9",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "00f09726-2c55-a136-7123-8d090b80c6b7",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "4e421115-4109-5d59-c5b2-a736e8a630ff",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "7dbe04ce-c09a-35b9-22e0-67ebdba9479c",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "1fd0bff0-a71c-6a1e-2a71-d21630ef6309",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "7b962379-f32c-9873-92a1-9873a9731434",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1927-02-05T15:36:20.0Z",
        "created_at": "1948-04-12T19:46:57.0Z",
        "updated_at": "1919-03-26T16:42:24.0Z",
        "deleted_at": "1952-05-29T05:01:23.0Z",
        "last_active_at": "1910-06-25T19:09:02.0Z",
        "email_verified_at": "1906-12-04T04:49:02.0Z",
        "last_check_in": {
          "checked_in_at": "1938-12-10T07:57:16.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "13eb655c-074d-30f5-c4d5-527331dd22be",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "Lorem laborum"
      },
      "members": [
        {
          "is_lead": true
        },
        {
          "customer_id": "405ff984-e42f-e4ee-fc7e-cc89c326f8df",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "b42ee64d-9f11-8d37-4a2a-94196d087877",
          "membership_number": "1234567890"
        },
        {
          "customer_id": "42d99694-de07-a8f4-6223-6e63848ed929",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "1e471611-bac2-4f98-be59-7a17fba9f7f1"
        }
      ],
      "type": {
        "id": "026880e7-bb5b-3305-a61a-9f4e7c680382",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "magna",
        "brand_id": "5cc19047-5d19-d977-fc15-ceeba205e003",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": true,
        "minimum_start_date": "1950-12-25T21:16:16.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "4c290f78-dc6c-2a7c-fb61-d7d4f47e6294",
            "membership_type_id": "f141e3ff-5b8f-7ad5-ee38-610fda339348",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "velit sunt",
              "ullamco",
              "ut est magna consequat ex",
              "do commodo nostrud"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1904-12-25T21:09:51.0Z",
            "updated_at": "1892-01-14T01:36:47.0Z"
          },
          {
            "id": "29a440e4-0507-6af5-8aaa-4c6190ce4fbf",
            "membership_type_id": "3a2cabda-2fc4-26d1-8098-8231c40ed6f3",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": []
          },
          {
            "id": "f3106169-65ff-f4eb-b114-005f11a2ef71",
            "membership_type_id": "35a710f6-abbb-f07e-a803-0c96d8fcdd07",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "nisi Duis culpa et eu"
            ],
            "default_duration": "P1Y",
            "private": true
          },
          {
            "id": "e139cc7c-7a60-6b11-895c-d7cecf2ee757",
            "membership_type_id": "2e13697a-6217-4f17-79fd-886935e85bb4",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "processors": [
              "Lorem nulla"
            ],
            "default_duration": "P1Y"
          },
          {
            "id": "416297d7-0cef-ddaf-c65f-ad7f5772efef"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1904-01-06T23:34:17.0Z",
        "updated_at": "1916-10-11T12:24:39.0Z",
        "deleted_at": "1952-07-30T01:21:08.0Z"
      },
      "rate": {
        "id": "51d407de-8c83-b49a-7877-98d5fa6f0320",
        "membership_type_id": "acc63e37-b51f-b1c2-3461-c64244aa2b5a",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "aute et esse dolore",
          "irure in mollit enim"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1912-06-19T16:34:16.0Z"
      },
      "status": "active",
      "source": "app",
      "payment_method": {
        "type": "direct_debit",
        "last_4": "dolore minim consectetur qui magna",
        "status": "revoked",
        "card_brand": "amex"
      },
      "end_date": "1965-09-19T21:03:06.0Z",
      "created_at": "1928-11-16T19:05:57.0Z",
      "basket_id": "688ba2beefe07e01610000a3",
      "external_ref": "aliqua est officia sint",
      "next_charge": {
        "id": "a81d1137-3ac0-3d27-264b-8a20771cb512",
        "amount": 3995,
        "currency": "GBP",
        "status": "pending",
        "billing_period_from": "1891-04-21",
        "billing_period_to": "1903-02-20"
      }
    },
    {
      "id": "cce8e42d-0da7-091c-a91f-3c10897d4921",
      "site_id": "3e86b896-c2be-54a4-7f1e-171fd17a4087",
      "membership_number": "1234567890",
      "customer": {
        "id": "ee243495-02bb-faa0-f4a5-c73d29a222a2",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1945-01-19",
        "brand_id": "5803ad60-8b35-c133-1358-bb60f120c88d",
        "site_id": "d089a809-b1a8-7190-53f7-7488155d12a3",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "5efde739-cb75-430a-43cc-2900f11d73d8",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "b84a41f7-d5f8-d75f-fb97-a0c507bb1c55",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "6ab17551-7f74-2099-692d-7eed74a9b6bb",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "afb11715-6012-f2ae-e549-cd7afcf57cf8",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "9d5f8ca7-c2a9-6959-c7a7-6cac21606a3f",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1931-12-02T07:52:10.0Z",
        "created_at": "1932-05-10T18:25:19.0Z",
        "updated_at": "1890-04-03T19:24:27.0Z",
        "deleted_at": "1969-10-09T22:17:05.0Z",
        "last_active_at": "1959-05-26T01:21:32.0Z",
        "email_verified_at": "1916-07-13T02:25:32.0Z",
        "last_check_in": {
          "checked_in_at": "1962-01-18T21:18:01.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "bfa37252-4570-cfd6-48d6-7636d211019f",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "adipisicing veniam id commodo"
      },
      "members": [
        {
          "customer_id": "65876027-a97d-a219-d5a1-a31482f8cc97",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "664e29ae-2d8b-e8f5-4613-1d509906b7a0",
          "is_lead": false
        },
        {
          "customer_id": "6ab50ace-834f-b575-8c81-f203c780767f",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "bacb2e1d-542d-9de4-1a5d-fa36a9e88f30",
          "membership_number": "1234567890",
          "is_lead": false
        }
      ],
      "type": {
        "id": "a1ad4327-0ac7-5d73-dcce-689ff9eb9b84",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "elit adipisicing enim",
        "brand_id": "161d274b-7422-42b4-bc20-9b3bc00b6427",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": true,
        "visibility": "public",
        "minimum_start_date": "1959-11-09T02:22:49.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1965-05-10T07:09:17.0Z",
        "updated_at": "1917-09-21T18:46:16.0Z",
        "deleted_at": "1900-12-29T21:46:16.0Z"
      },
      "rate": {
        "id": "940e51f9-ae8b-9e0d-9237-acaad43f7b34",
        "membership_type_id": "d660f002-3288-4c00-b755-5f0bff27b33b",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "incididunt",
          "sunt est dolore sint",
          "adipisicing",
          "anim sit sunt amet nulla",
          "adipisicing deserunt non"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1968-09-13T15:01:25.0Z",
        "updated_at": "1949-04-29T01:16:26.0Z"
      },
      "status": "upcoming",
      "payment_method": {
        "id": "veniam dolore in eu officia",
        "type": "card",
        "last_4": "exercitation quis aliqua amet labore",
        "status": "revoked",
        "card_brand": "amex"
      },
      "start_date": "1967-12-28T10:42:48.0Z",
      "end_date": "1909-01-26T20:39:01.0Z",
      "created_at": "1947-04-10T01:43:27.0Z",
      "basket_id": "688ba2beefe07e01610000a4",
      "external_ref": "elit culpa",
      "next_billing_date": "1911-09-28T02:12:46.0Z",
      "next_charge": {
        "id": "1cb5bac6-87e3-ad74-c7d1-fa4c3f4e66bb",
        "amount": 3995,
        "currency": "GBP",
        "status": "errored",
        "billing_period_from": "1905-03-05",
        "billing_period_to": "1960-12-07"
      },
      "attention_reason": "payment_failed"
    },
    {
      "id": "673f5869-7ef2-e4d4-0113-61f2645aba7e",
      "site_id": "b4ac5b31-af7d-04c0-31de-2e7a6a42e231",
      "membership_number": "1234567890",
      "members": [
        {
          "customer_id": "86821d28-1630-da29-820e-ed9ff9bfbd91",
          "membership_number": "1234567890"
        },
        {
          "customer_id": "7ba081a9-89a7-39e5-fa28-a073149fa8eb",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "a61a2070-43ca-6bfb-ae0d-87cc26d6937d"
        },
        {
          "customer_id": "d19c2e22-c130-06fc-5967-9e08490d285c",
          "membership_number": "1234567890"
        }
      ],
      "type": {
        "id": "ad9d7b89-9e13-f455-9553-a85b9cd2aa04",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "nulla mollit",
        "brand_id": "ad7df697-5b07-d164-f722-65a220b9d2c1",
        "offline_payments": true,
        "disable_confirmation_email": true,
        "private": true,
        "visibility": "link_only",
        "minimum_start_date": "1931-10-25T22:53:41.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "ebd4d8c5-f916-789e-bf3c-5b6f049cd1c8",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "occaecat",
              "quis dolor incididunt tempor"
            ],
            "private": true
          },
          {
            "id": "df10671b-5b88-9e13-0106-67162b7c0b80",
            "membership_type_id": "a43002a3-0b19-6ac2-52e6-4a97fd340346",
            "currency": "GBP",
            "price": 5000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "dolor labore consequat voluptate cillum",
              "elit nisi et dolore aliqua",
              "dolore minim"
            ],
            "private": true
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1898-09-26T20:05:30.0Z",
        "updated_at": "1915-11-18T01:23:26.0Z",
        "deleted_at": "1967-06-08T10:26:52.0Z"
      },
      "status": "active",
      "start_date": "1930-12-10T09:29:16.0Z",
      "end_date": "1942-11-04T11:07:16.0Z",
      "created_at": "1896-12-17T09:39:04.0Z",
      "next_billing_date": "1899-10-21T06:12:01.0Z",
      "next_charge": {
        "id": "9464a1eb-a1c5-c750-2979-8680e92287bb",
        "amount": 3995,
        "currency": "GBP",
        "status": "awaiting_approval",
        "billing_period_from": "1931-09-02",
        "billing_period_to": "1909-05-15"
      },
      "attention_reason": "payment_disputed"
    },
    {
      "id": "eea7fbb5-6e45-d057-b1be-ed3e3db16718",
      "site_id": "b57b2710-c522-b275-464f-7b72e204c690",
      "membership_number": "1234567890",
      "customer": {
        "id": "d444e5a9-bd27-b4cd-fad8-0a374fcd847b",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1953-01-03",
        "brand_id": "b912e48f-870c-9867-ef96-653c8d7abb32",
        "site_id": "7df5e5b9-c09f-63bb-c52e-aa1aa5bfe37e",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "50aa9f03-0efc-aadf-5bbf-4f545cb7382d",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "c0690d4c-1754-0d0d-99eb-50fee400b91e",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "c6a48534-5a05-5b88-179c-3a329926d3c6",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "b06abb1d-ba89-a0dd-45bb-903ffd3cd838",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1911-05-24T01:50:35.0Z",
        "created_at": "1939-05-28T09:58:18.0Z",
        "updated_at": "1893-07-23T11:42:18.0Z",
        "deleted_at": "1904-10-05T23:51:30.0Z",
        "last_active_at": "1913-01-20T17:04:31.0Z",
        "email_verified_at": "1935-02-26T01:10:15.0Z",
        "last_check_in": {
          "checked_in_at": "1897-05-24T12:05:39.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "d7cd948d-78c8-3326-6c45-491cb1ec37ee",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "ullamco sunt"
      },
      "members": [
        {
          "customer_id": "abff5e6d-e920-0371-e64d-8d61959ca6d4",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "2d44cc9c-4835-bfcb-d745-74ed6e05568e"
        },
        {
          "customer_id": "b029b0b3-93d0-6f81-94f1-e2f6a07616e3",
          "membership_number": "1234567890"
        },
        {
          "customer_id": "b4179653-00c8-eda2-fa4e-ea4351fff7eb"
        },
        {
          "membership_number": "1234567890",
          "is_lead": false
        }
      ],
      "type": {
        "id": "948ff28a-4a08-5760-b735-fed66197ba0c",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "in in",
        "brand_id": "64a3961a-0885-b1b2-cba5-896912faa5b4",
        "offline_payments": true,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "private",
        "minimum_start_date": "1892-08-25T14:09:27.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "b5305371-33d7-04c4-034f-7f91c1f27d8e",
            "membership_type_id": "2fed213d-de52-1b02-e26e-23d52c3a01ac",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1930-12-24T02:41:29.0Z",
            "updated_at": "1965-09-19T08:04:32.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1910-03-04T06:15:59.0Z",
        "updated_at": "1968-05-23T21:18:48.0Z",
        "deleted_at": "1902-11-06T21:35:30.0Z"
      },
      "rate": {
        "id": "5993f4c0-7648-077a-faaa-782eb5330f93",
        "membership_type_id": "4ca42483-b023-d181-6508-7e22023d8ad4",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M"
      },
      "status": "needs_attention",
      "source": "app",
      "payment_method": {
        "id": "enim",
        "type": "card"
      },
      "start_date": "1964-01-02T08:40:49.0Z",
      "end_date": "1967-11-01T01:57:18.0Z",
      "created_at": "1927-08-20T09:04:10.0Z",
      "basket_id": "688ba2beefe07e01610000a5",
      "next_billing_date": "1891-04-14T12:36:56.0Z",
      "next_charge": {
        "id": "328a6651-55ab-c612-d95e-49d3166dbdcd",
        "amount": 3995,
        "currency": "GBP",
        "status": "pending",
        "billing_period_from": "1911-01-22",
        "billing_period_to": "1901-08-06"
      },
      "attention_reason": "payment_failed"
    }
  ],
  "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": "1d9659ad-38d9-6b1c-0b0f-ff16a68c1e63",
    "membership_number": "1234567890",
    "customer": {
      "id": "98614e54-b5c5-beb0-456f-e36b50b2f2e6",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1962-07-25",
      "brand_id": "9eba6e52-dcd3-5b91-206f-e9fd33d1bc64",
      "site_id": "277918e4-507c-b13c-ca05-077a66a86283",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "c301fd41-126e-9a20-fdd1-baa0155e3fec",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "74b3d303-cc91-343c-b34a-1ce01850de87",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "2f68c74d-38b4-be36-fdfe-c2f9f836b0a8",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "c807014c-32fe-6f4e-5b23-c0264ccbb567",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "183e5e57-9cdd-775f-81ad-422e70a66a22",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1941-04-30T13:33:55.0Z",
      "created_at": "1899-03-17T14:40:32.0Z",
      "updated_at": "1923-03-19T17:24:47.0Z",
      "deleted_at": "1904-07-05T22:13:08.0Z",
      "last_active_at": "1895-10-13T05:35:50.0Z",
      "email_verified_at": "1905-02-10T13:37:06.0Z",
      "last_check_in": {
        "checked_in_at": "1913-05-22T13:02:07.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "dc15f833-f1f3-b810-55b3-1495b804b717",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo.jpg"
      },
      "external_ref": "in labore esse"
    },
    "members": [
      {
        "customer_id": "5fd20933-6436-1ddb-bf95-97a415dcf14c"
      },
      {
        "customer_id": "1f5059ad-ed8e-fc46-0a98-b2bcc93c0c05",
        "membership_number": "1234567890",
        "is_lead": false
      },
      {
        "customer_id": "3e0720ef-939f-3416-9df2-ccab66254930",
        "membership_number": "1234567890",
        "is_lead": false
      }
    ],
    "status": "active",
    "source": "import",
    "start_date": "1942-04-25T21:04:59.0Z",
    "created_at": "1953-04-22T04:44:57.0Z",
    "basket_id": "688ba2beefe07e01610000a6",
    "external_ref": "sed eiusmod officia tempor veniam",
    "next_billing_date": "1937-12-18T22:31:53.0Z",
    "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/memberships/{membershipId}/charges/{chargeId}/payment
200
example response
{
  "data": {
    "id": "5b0a5cc4-6120-9e39-6e93-2ca083ef34ec",
    "membership": {
      "id": "49a0d28f-85b0-0dd3-2b19-a04b539dd3e9",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "73eb9f3d-88de-8d3a-1caa-7b210ea45359"
    },
    "processor": "adyen",
    "processor_data": {},
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "can_download_receipt": false,
    "amount_refunded": "dolore enim",
    "refunded": "mollit",
    "refunds": [
      {
        "id": "52dab7aa-ab9c-61b7-0c2a-f11e51a1c588",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "f31040d7-63cb-906e-d147-791ce0460a28",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1895-02-18T09:43:42.0Z",
        "updated_at": "1955-03-05T03:09:24.0Z"
      },
      {
        "id": "82bf8470-34ae-2ab5-73f7-c667032e6536",
        "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": "1934-06-11T10:26:18.0Z",
        "updated_at": "1959-01-04T09:08:31.0Z"
      },
      {
        "id": "1888a8bd-3907-601f-7a26-6bf953bfed41",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "ed26fc47-2e1a-b33d-37d2-487de2dd82dc",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1906-09-08T11:39:26.0Z",
        "updated_at": "1954-01-01T17:47:31.0Z"
      },
      {
        "id": "b372c32b-be18-7f8e-6207-b1470234fb20",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "f94275f5-b162-dc7d-f0e4-01fac62ececa",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1947-06-09T07:01:07.0Z",
        "updated_at": "1932-06-17T06:04:48.0Z"
      }
    ],
    "site_id": "f28dbb25-756c-4498-fc28-8c4a91bdc816",
    "billing_period_from": "1944-01-28",
    "billing_period_to": "1899-07-04",
    "created_at": "1917-03-09T03:11:57.0Z",
    "updated_at": "1965-07-23T06:43:39.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/memberships/{membershipId}/charges/{chargeId}/process
200
example response
{
  "data": {
    "id": "de089b8c-0c99-f163-bc65-6c04b81e271b",
    "membership": {
      "id": "d14106e5-9915-4fd5-6422-61cf4bd0df20",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "e51ba2d7-660d-0ff7-bca9-36506ebf80ea"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "688ba2beefe07e01610000a7"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "can_download_receipt": true,
    "amount_refunded": "dolor dolore voluptate culpa",
    "refunded": "eiusmod ipsum dolor",
    "refunds": [
      {
        "id": "8bc19dcf-1d34-a4c4-eceb-408b599094ad",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "57d65468-6dbe-5ccf-0a86-1714ede1ab6c",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1967-07-19T09:37:25.0Z",
        "updated_at": "1893-04-14T14:17:03.0Z"
      },
      {
        "id": "757a198c-af32-ad9f-ae28-0bb621ad312f",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "71be4fb1-1099-1adf-a688-0fa2107062d3",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1959-10-01T11:44:57.0Z",
        "updated_at": "1939-06-12T23:05:07.0Z"
      },
      {
        "id": "ff55b302-ac8b-9e00-7945-bc1c2f0d77ea",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "ababef22-7797-7b70-39cd-3597bbc1e63c",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1934-11-28T13:08:04.0Z",
        "updated_at": "1902-09-22T05:15:26.0Z"
      },
      {
        "id": "f355507d-ab92-fefc-cfa0-44513b8818d8",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "refunded_by": {
          "id": "a4983f55-43dd-0c78-65c3-80a79e400a38",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1948-09-06T02:59:13.0Z",
        "updated_at": "1938-03-27T17:26:40.0Z"
      },
      {
        "id": "98f0b906-ae92-6847-2c0f-d16f340f1830",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "67fe320c-2530-5348-ea7b-1397047d6fcd",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1921-04-02T14:44:56.0Z",
        "updated_at": "1969-07-01T03:19:41.0Z"
      }
    ],
    "site_id": "dc8fefee-61d7-711a-3acb-66accbebbf00",
    "billing_period_from": "1962-04-03",
    "billing_period_to": "1933-09-09",
    "created_at": "1894-02-22T15:45:31.0Z",
    "updated_at": "1945-04-09T02:46:21.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}