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": "cc91b5e3-8f67-5874-e375-632edcc6cb67",
      "site_id": "705bad25-0d8b-cbea-2d1f-6f91528a879d",
      "customer": {
        "id": "31d8dcec-d86b-5f62-1af9-d25e4af93fe9",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1891-05-10",
        "brand_id": "dc80c72d-aa72-df8a-19dd-48a0d87b7d38",
        "site_id": "5b49fb42-44c0-07cb-bcbd-1d8f43971d8b",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "fde055ec-3f93-e810-fcc0-55aeaf9e4abe",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "2a9d430d-a3c2-727e-2006-6b9acaf36f1d",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "9a90d42e-ef2f-67ed-54ca-4f36dc702348",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "5eedeaa0-d895-410c-1f4d-6ef43c011545",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "3e4811c2-cb05-200d-2230-008e9d58275a",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1941-12-19T03:51:52.0Z",
        "created_at": "1950-05-08T16:33:31.0Z",
        "updated_at": "1959-06-06T14:17:31.0Z",
        "deleted_at": "1939-04-09T01:27:39.0Z",
        "last_active_at": "1962-05-14T01:06:15.0Z",
        "email_verified_at": "1947-03-22T09:29:54.0Z",
        "last_check_in": {
          "checked_in_at": "1911-01-29T10:16:23.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "f6c49c55-4d30-30d8-e1f1-ca520e83fc9e",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "est do anim nulla"
      },
      "members": [
        {
          "customer_id": "8c32db37-be4b-821d-26f8-91cf6343f275",
          "membership_number": "1234567890",
          "is_lead": true
        }
      ],
      "type": {
        "id": "10374986-504a-be97-0930-3f2b09664eaa",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "dolore dolore",
        "brand_id": "2169f2ad-1752-27bf-87a2-8581f98d1f60",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "private",
        "minimum_start_date": "1937-02-24T13:19:41.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "55dafd78-c27e-1a2e-7f0c-3909fbb82e3a",
            "membership_type_id": "4ddf5e4c-ee60-f68a-4f8e-43a5853ecce0",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "private": true,
            "created_at": "1959-07-28T10:02:07.0Z",
            "updated_at": "1955-06-29T19:37:04.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1920-12-13T21:12:19.0Z",
        "updated_at": "1899-05-21T20:44:38.0Z",
        "deleted_at": "1923-04-04T14:33:49.0Z"
      },
      "rate": {
        "id": "c97d4c96-7a24-4ea4-ceae-6d9c55e9c2bb",
        "membership_type_id": "f7d47c53-c867-0820-d504-843e3950c9ff",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "id tempor qui",
          "velit Lorem ad",
          "esse dolore nisi"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1897-01-17T02:21:42.0Z",
        "updated_at": "1894-05-03T04:58:08.0Z"
      },
      "start_date": "1911-09-26T06:25:45.0Z",
      "basket_id": "68caab1a150f9201250000ca",
      "next_billing_date": "1964-04-26T16:33:07.0Z",
      "next_charge": {
        "id": "c3a0a699-d04d-d99a-8c4d-f7f3974e2352",
        "amount": 3995,
        "currency": "GBP",
        "status": "pending",
        "billing_period_from": "1910-09-15",
        "billing_period_to": "1915-04-03"
      }
    },
    {
      "id": "04ad545c-116a-e126-f9a1-1303ff055d84",
      "site_id": "bdeaab99-3e86-3c41-d744-b1744e9c680a",
      "membership_number": "1234567890",
      "customer": {
        "id": "9428cdc7-2cc3-a29a-3e78-e2cb2594b215",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1925-06-05",
        "brand_id": "7f6662df-9463-5de4-468f-28d1b4dcadb1",
        "site_id": "ed203daa-ad18-8c8e-8607-8d069fcf8123",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "d5055dc1-9638-9d7b-e47d-f6e39f21e233",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "f21cafb8-a112-9847-f21f-56adbb153748",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "c6e53ff6-bd6b-b745-99bf-fb790e81aa23",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1926-10-28T01:27:21.0Z",
        "created_at": "1947-03-22T03:14:32.0Z",
        "updated_at": "1961-02-15T19:13:28.0Z",
        "deleted_at": "1968-03-02T14:29:08.0Z",
        "last_active_at": "1912-04-12T18:34:02.0Z",
        "email_verified_at": "1954-02-19T10:06:26.0Z",
        "last_check_in": {
          "checked_in_at": "1959-07-20T07:30:29.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "141a346f-65c6-eb84-d038-40b1e67552a9",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "consectetur"
      },
      "members": [
        {
          "customer_id": "dda9bf69-2331-efe0-f58d-e25d293b42f0",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "e0487e6e-de2c-ef2c-afd2-c6e34472c0d3",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "2a6db7b6-1117-2b53-b1b7-79bb1caa3da0",
          "is_lead": false
        },
        {
          "customer_id": "a23c7350-52eb-e83e-4d65-5c7231b84d61",
          "is_lead": false
        }
      ],
      "rate": {
        "id": "2e932a88-6d95-bf35-a4f6-02b7c85518df",
        "membership_type_id": "0e411ad5-5fe0-785a-2462-0b9ca994747e",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1962-06-20T09:54:06.0Z",
        "updated_at": "1900-07-22T04:36:46.0Z"
      },
      "status": "inactive",
      "source": "unknown",
      "start_date": "1905-03-21T01:37:53.0Z",
      "end_date": "1900-06-29T07:23:30.0Z",
      "basket_id": "68caab1a150f9201250000cb",
      "external_ref": "eu laboris adipisicing",
      "next_billing_date": "1904-02-12T21:23:06.0Z",
      "next_charge": {
        "id": "afe9a025-0343-0964-f4cb-58eb6c49acdb",
        "amount": 3995,
        "currency": "GBP",
        "status": "errored",
        "billing_period_from": "1920-11-06",
        "billing_period_to": "1912-12-25"
      },
      "attention_reason": "no_mandate"
    },
    {
      "id": "b6868fc8-65ae-423d-3fa2-4b6a96800b20",
      "site_id": "ab8b86d5-84e3-6e10-54e2-57f65e5aff42",
      "membership_number": "1234567890",
      "customer": {
        "id": "21fb4bbe-94c0-e799-890c-7a0905378080",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1913-01-02",
        "brand_id": "c6c786e9-fafc-ae4e-d5cc-c6abfb1c7b20",
        "site_id": "83040b17-572b-684a-ce0d-fd74a3c5499b",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "a4dfb8de-8eb4-4d9f-36bf-639250ba5021",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "2b7979c9-8186-8f0c-5247-e994385f40ae",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1927-05-10T06:05:42.0Z",
        "created_at": "1906-04-29T04:11:13.0Z",
        "updated_at": "1916-12-13T04:50:18.0Z",
        "deleted_at": "1926-01-16T17:03:39.0Z",
        "last_active_at": "1926-03-16T13:50:05.0Z",
        "email_verified_at": "1914-06-12T06:57:27.0Z",
        "last_check_in": {
          "checked_in_at": "1944-08-18T19:30:11.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "a61fc51c-6316-362c-5ef9-c3a762f76e83",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "in"
      },
      "members": [
        {
          "customer_id": "eebd2e0b-276b-ed00-09c7-d070ba64d57e",
          "membership_number": "1234567890",
          "is_lead": false
        }
      ],
      "type": {
        "id": "ea25d074-9109-90b5-a4f4-1d6a97136f76",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "dolor ad aliquip",
        "brand_id": "fd5e3ebe-fa09-91ac-24d4-0b182d95b66b",
        "offline_payments": true,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "link_only",
        "minimum_start_date": "1946-11-24T13:02:28.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "6aaa4c70-eb30-08b4-4e5d-ce7de19fce9f",
            "membership_type_id": "316fe8bd-f0f4-d8dc-582e-c899ec2e357f",
            "name": "Standard rate",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "in dolore aliquip in veniam"
            ],
            "default_duration": "P1Y",
            "created_at": "1939-06-14T22:24:02.0Z",
            "updated_at": "1926-03-12T02:57:35.0Z"
          },
          {
            "id": "e5f50862-b035-f468-603e-36243a82e9f8",
            "membership_type_id": "cb3c5289-90f6-676f-4613-cfecc1d4817c",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "processors": [],
            "private": true
          },
          {
            "membership_type_id": "b3a82d57-ec79-2111-a697-b44b63d58690",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "laboris sunt commodo",
              "velit est ipsum dolor",
              "Excepteur laboris ipsum"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1944-12-31T16:59:50.0Z"
          },
          {
            "id": "972eade8-793b-a266-f816-e0c3a94b14a0",
            "tax": 1250,
            "billing_frequency": "P1M",
            "private": true,
            "created_at": "1906-11-01T23:41:10.0Z"
          },
          {
            "currency": "GBP",
            "price": 5000,
            "billing_frequency": "P1M",
            "processors": [],
            "created_at": "1904-04-20T02:36:41.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1912-10-26T02:23:15.0Z",
        "updated_at": "1894-11-05T01:29:41.0Z",
        "deleted_at": "1890-05-02T23:34:22.0Z"
      },
      "rate": {
        "membership_type_id": "da6edd75-e0e1-ef5c-2ed1-0b9ebb3f8e67",
        "name": "Standard rate",
        "price": 5000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "exercitation",
          "enim",
          "cupidatat ut quis",
          "ut"
        ],
        "default_duration": "P1Y",
        "created_at": "1966-03-27T04:56:06.0Z",
        "updated_at": "1934-12-06T03:15:19.0Z"
      },
      "status": "inactive",
      "source": "import",
      "start_date": "1961-08-16T16:53:25.0Z",
      "end_date": "1909-11-30T07:09:11.0Z",
      "created_at": "1906-03-20T01:23:53.0Z",
      "basket_id": "68caab1a150f9201250000cc",
      "external_ref": "id incididunt magna dolor do",
      "attention_reason": "no_mandate"
    },
    {
      "id": "00e01ef0-a269-eedf-9457-4778ad36310b",
      "site_id": "c1d60b7c-6a58-8ae9-ca9f-34b82bc9dab7",
      "membership_number": "1234567890",
      "customer": {
        "id": "3132f11c-fd0c-afd2-9c21-5d70dad62210",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1966-12-06",
        "brand_id": "a6883e08-be11-afd3-feab-582f16429c99",
        "site_id": "e30659e4-301f-8937-b3dd-639ff6c36c9a",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "b78c9d5c-95a9-78de-fa83-bc401f8c69a7",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "890f5eac-12d0-a537-b53a-09a9f6738857",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "9de617e1-8f69-6201-f720-2cad18e6f1a4",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1943-12-02T18:08:13.0Z",
        "created_at": "1946-04-18T14:21:21.0Z",
        "updated_at": "1908-06-10T01:21:40.0Z",
        "deleted_at": "1964-06-13T20:22:14.0Z",
        "last_active_at": "1933-03-31T01:21:41.0Z",
        "email_verified_at": "1940-06-30T21:14:11.0Z",
        "last_check_in": {
          "checked_in_at": "1902-12-31T23:24:47.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "ea507aef-fa7a-f285-f94a-442b8e101b11",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "sint in"
      },
      "members": [
        {
          "customer_id": "a2ec8230-0bf7-28b7-efba-e4f0ad45ebd9",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "f321bf84-0b6c-12b6-8056-3c1437eaca61",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "03b3c231-363a-9449-8158-1bc6d8490d24",
          "membership_number": "1234567890",
          "is_lead": true
        }
      ],
      "type": {
        "id": "b477da50-df01-99e5-8186-3f4514afe4d5",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "anim eu cillum nulla",
        "brand_id": "357cdf46-3336-49e4-8d2a-627342e477c6",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": true,
        "visibility": "link_only",
        "minimum_start_date": "1921-02-13T11:38:13.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "8d1fbc9f-ce08-8f94-3c6f-87d59fcc0b67",
            "membership_type_id": "1c32f48a-7f18-20af-9701-6a6776815f52",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "ullamco"
            ],
            "default_duration": "P1Y"
          },
          {
            "id": "97c9afe1-ebc6-dca4-f1d7-38e003abcf41"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1891-03-21T15:01:25.0Z",
        "updated_at": "1918-12-11T23:50:37.0Z",
        "deleted_at": "1967-02-23T04:34:40.0Z"
      },
      "rate": {
        "id": "d5a26713-dd33-8794-3b7a-901deb78e3e5",
        "membership_type_id": "d1b2cd1a-095b-37c2-c3b8-3c576555cc75",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "created_at": "1933-08-06T20:27:40.0Z"
      },
      "status": "active",
      "source": "self_signup",
      "payment_method": {
        "id": "consequat nisi deserunt quis elit",
        "type": "direct_debit",
        "last_4": "in consequat Lorem ea officia",
        "card_brand": "amex"
      },
      "start_date": "1922-05-19T16:40:56.0Z",
      "end_date": "1968-09-19T19:46:31.0Z",
      "created_at": "1901-07-25T22:44:31.0Z",
      "basket_id": "68caab1a150f9201250000cd",
      "next_billing_date": "1961-05-12T08:05:31.0Z",
      "next_charge": {
        "id": "915bc58f-25e4-894e-06a9-6b07a7b7c502",
        "amount": 3995,
        "currency": "GBP",
        "status": "failed",
        "billing_period_from": "1959-05-10",
        "billing_period_to": "1901-01-26"
      },
      "attention_reason": "site_id"
    }
  ],
  "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": "8d42cbf5-f7fa-c424-ba98-40485d56db92",
    "site_id": "0191c5a8-2ddb-a66b-7b04-e2187a3b7713",
    "membership_number": "1234567890",
    "customer": {
      "id": "bea67f25-3cd5-af31-15ab-1f5a8e80b9d1",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1909-02-24",
      "brand_id": "0739e158-1dde-b494-d88a-e4db7ef3c968",
      "site_id": "72da4466-bf5c-1b7a-a868-df95104cf0de",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "4ef4e1cf-f45e-2764-d52f-451a632e42bd",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "1d407925-fbe2-2b3b-d950-b093f8172fdc",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "4eca9a32-ede1-a606-d979-f6a3c1e4e6a1",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1924-07-04T18:35:15.0Z",
      "created_at": "1901-07-29T15:19:35.0Z",
      "updated_at": "1963-04-02T20:23:28.0Z",
      "deleted_at": "1918-07-07T08:01:27.0Z",
      "last_active_at": "1936-03-11T18:19:19.0Z",
      "email_verified_at": "1964-10-13T11:47:58.0Z",
      "last_check_in": {
        "checked_in_at": "1943-02-08T14:20:43.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "5f23e6eb-f8a6-70c4-127c-52c2cd330151",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo.jpg"
      },
      "external_ref": "consectetur et mollit"
    },
    "members": [],
    "type": {
      "id": "f9bd206f-739f-61e4-ca20-aa53ed40c3d5",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "nisi",
      "brand_id": "2220127a-10ba-aa4f-ea75-2e02729ae1f6",
      "offline_payments": true,
      "disable_confirmation_email": true,
      "private": false,
      "visibility": "public",
      "minimum_start_date": "1959-01-18T14:52:08.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "id": "d815e040-a6c2-2ddf-7be4-922193f65f62",
          "membership_type_id": "99fa3791-359e-04a4-9995-1f5c7051f757",
          "name": "Standard rate",
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "processors": [],
          "updated_at": "1932-01-11T11:44:18.0Z"
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1959-01-18T01:31:21.0Z",
      "updated_at": "1911-10-06T18:52:39.0Z",
      "deleted_at": "1926-06-25T15:30:42.0Z"
    },
    "rate": {
      "id": "7e74a9ef-5486-84ba-7375-527933c3c04c",
      "membership_type_id": "55286992-b2ec-443a-235a-6420075d262a",
      "name": "Standard rate",
      "currency": "GBP",
      "price": 5000,
      "joining_fee": 1000,
      "tax": 1250,
      "billing_frequency": "P1M",
      "processors": [
        "aliqua culpa mollit ut"
      ],
      "default_duration": "P1Y",
      "private": true,
      "created_at": "1956-04-29T15:51:33.0Z",
      "updated_at": "1919-04-03T16:19:35.0Z"
    },
    "status": "active",
    "source": "import",
    "payment_method": {
      "id": "amet reprehenderit veniam esse elit",
      "type": "direct_debit",
      "last_4": "esse non et nulla sed",
      "status": "revoked",
      "card_brand": "amex"
    },
    "start_date": "1924-08-07T09:32:38.0Z",
    "end_date": "1898-01-04T15:38:52.0Z",
    "created_at": "1935-11-07T17:05:41.0Z",
    "basket_id": "68caab1a150f9201250000ce",
    "external_ref": "consequat",
    "next_billing_date": "1917-02-23T16:04:06.0Z",
    "next_charge": {
      "id": "00ce741e-2981-25ff-67d8-0deaa4c79d9c",
      "amount": 3995,
      "currency": "GBP",
      "status": "succeeded",
      "billing_period_from": "1890-06-26",
      "billing_period_to": "1898-12-04"
    },
    "attention_reason": "payment_failed"
  }
}
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": "fde4a1eb-7781-cc10-3b9d-c439b7a77169",
    "membership": {
      "id": "fa518983-2eae-dc4a-e65e-1b031e151989",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "fe0ed075-af27-9da9-5351-f76c7d2bd07e",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "68caab1a150f9201250000cf"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "nostrud Excepteur in consequat magna",
    "can_download_receipt": true,
    "amount_refunded": "sunt exercitation culpa",
    "refunded": "mollit dolore aliqua eu",
    "refunds": [
      {
        "id": "7613ac5d-dd7a-adf1-c0f2-3b8bb36d0c19",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "a3447158-d946-7841-0953-bd89f2d78ee1",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1899-09-13T21:17:24.0Z",
        "updated_at": "1931-02-10T12:03:51.0Z"
      },
      {
        "id": "ce891b42-bcdc-0c70-65c9-d09dd326f9ca",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "3fda55bd-8ea5-370e-907e-ba668e86935b",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1934-05-31T21:50:58.0Z",
        "updated_at": "1895-02-28T19:33:25.0Z"
      }
    ],
    "site_id": "352b1a49-aa79-5e39-d182-148ac32b90de",
    "billing_period_from": "1954-08-25",
    "billing_period_to": "1922-08-16",
    "processing_at": "1964-08-04T06:42:11.0Z",
    "created_at": "1939-05-14T20:27:56.0Z",
    "updated_at": "1944-11-17T10:38:01.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": "93cf836d-9b7f-a937-2492-5ab9de7307ae",
    "membership": {
      "id": "4d07f56f-6002-9189-5399-16df453e1bb0",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "af64f4b0-2245-969b-6f44-03eb627ed21f",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type_id": "68caab1a150f9201250000d0"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "voluptate",
    "can_download_receipt": false,
    "amount_refunded": "Duis in",
    "refunded": "reprehenderit adipisicing veniam enim",
    "refunds": [
      {
        "id": "7388f067-0e36-ef02-d1d8-558b9cd5c066",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "refunded_by": {
          "id": "901277b9-1568-5f51-8f8e-21953b28eb43",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1921-10-09T07:06:09.0Z",
        "updated_at": "1930-08-29T18:56:27.0Z"
      }
    ],
    "site_id": "ef4c1a4c-8952-d59e-803a-e3d5a46d8f11",
    "billing_period_from": "1899-05-14",
    "billing_period_to": "1927-04-02",
    "processing_at": "1899-06-13T21:49:02.0Z",
    "created_at": "1925-12-01T14:03:19.0Z",
    "updated_at": "1919-09-15T10:36:21.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": "97a50b2b-06ea-874d-3fc8-7bf96eb5e89e",
    "membership": {
      "id": "b08ebb6b-b7e9-19ec-013f-d0612b772538",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "aaa98835-bcfb-67cb-6a04-56eefdc10377",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "processor_type": "Cash"
    },
    "amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "sit minim id",
    "can_download_receipt": true,
    "amount_refunded": "consectetur",
    "refunded": "tempor",
    "refunds": [
      {
        "id": "bc3b0bf8-cdb3-2321-1356-8584b2dcfbdf",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "55415efd-8d5d-2525-a7a7-e5a58e892e23",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1923-01-17T20:04:16.0Z",
        "updated_at": "1900-12-30T03:41:54.0Z"
      },
      {
        "id": "17d7e9d1-f223-1554-478c-38611b545b0d",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1925-04-05T12:12:06.0Z",
        "updated_at": "1967-06-17T01:29:16.0Z"
      }
    ],
    "site_id": "042bb788-5175-0a45-1f44-34fe298cfbaa",
    "billing_period_from": "1907-02-14",
    "billing_period_to": "1919-06-17",
    "created_at": "1926-09-19T16:25:30.0Z",
    "updated_at": "1948-11-05T09:33:01.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}