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": "dbaa85da-e648-3b47-0793-6349acd05116",
      "site_id": "26313eb1-570d-3f45-fda1-b629e1508ca1",
      "membership_number": "1234567890",
      "customer": {
        "id": "bfffe3cd-69f3-791a-717b-64832d00ec7b",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1913-12-30",
        "brand_id": "fbf0b1fb-0328-a9ef-83da-26971cfdc85e",
        "site_id": "cde68eda-9d2b-88c6-8156-be9a6f92494e",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "66297756-0b6d-dded-7cb6-32baee254bc1",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "eb05e878-ace0-20c2-04eb-7caee60f507e",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "8812041c-14e3-dbe3-b786-8e721a36dbbf",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "8b4f7c1b-ec95-bd7a-9028-13aea5ff99cb",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "86062e63-8774-c42a-8b26-3d5f24a97a58",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1891-02-20T16:56:38.0Z",
        "created_at": "1919-09-06T06:32:09.0Z",
        "updated_at": "1946-12-18T12:37:53.0Z",
        "deleted_at": "1944-11-26T04:53:40.0Z",
        "last_active_at": "1920-01-14T22:28:53.0Z",
        "email_verified_at": "1932-12-28T02:05:36.0Z",
        "last_check_in": {
          "checked_in_at": "1917-07-29T12:47:47.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "d8dcec6e-5bd2-07b1-007e-b58665968c0e",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "dolor ipsum non"
      },
      "members": [],
      "type": {
        "id": "ee8fcd2b-a9d0-b635-371b-6e353d1df6ab",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "incididunt elit",
        "brand_id": "1512b542-ab90-375f-73f8-435b1e0b9c78",
        "offline_payments": true,
        "disable_confirmation_email": false,
        "private": true,
        "visibility": "link_only",
        "minimum_start_date": "1904-04-18T15:24:26.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "5447f65c-f7f2-5d5f-363d-2ff653e839c7",
            "membership_type_id": "633fb488-9dbb-666a-aa9a-cae692a79967",
            "name": "Standard rate",
            "billing_frequency": "P1M",
            "processors": [
              "ea tempor fugiat",
              "voluptate dolor tempor ut",
              "sint",
              "adipisicing Duis ut est ullamco",
              "ex aliqua esse nostrud"
            ],
            "private": true,
            "updated_at": "1901-11-05T17:44:27.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1897-08-11T20:26:29.0Z",
        "updated_at": "1892-01-24T15:45:44.0Z",
        "deleted_at": "1933-12-24T01:59:26.0Z"
      },
      "rate": {
        "id": "894a14aa-888c-c787-7eb8-cae7f9e40d49",
        "membership_type_id": "560c7842-fa19-1dc8-0d69-a4fd4cb9fb73",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "reprehenderit Excepteur cillum nisi",
          "Excepteur nostrud",
          "in quis minim cillum nulla",
          "Lorem exercitation Ut aliquip et"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1899-06-22T21:59:57.0Z",
        "updated_at": "1969-06-15T01:40:39.0Z"
      },
      "status": "needs_attention",
      "source": "unknown",
      "payment_method": {
        "id": "dolore do elit et eiusmod",
        "last_4": "adipisicing"
      },
      "start_date": "1924-04-26T01:01:41.0Z",
      "end_date": "1916-03-10T03:03:27.0Z",
      "created_at": "1952-09-14T20:21:53.0Z",
      "basket_id": "68c3ebfeea9fe1012b0000a1",
      "external_ref": "Ut ea elit pariatur",
      "next_charge": {
        "id": "5acc873d-331d-a461-4a03-c02e0a41c6b5",
        "amount": 3995,
        "currency": "GBP",
        "status": "succeeded",
        "billing_period_from": "1942-10-21",
        "billing_period_to": "1899-08-11"
      }
    },
    {
      "id": "8c2b965e-2e8d-28aa-b169-4b7c37b5bcb3",
      "site_id": "356206b2-76fb-b92b-4476-fbad025d4ba3",
      "membership_number": "1234567890",
      "customer": {
        "id": "d3e7ecba-e0e2-8e6f-2df1-286f98c7c35b",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1962-06-24",
        "brand_id": "dde4d754-2cfe-44a3-9ba3-50086445a448",
        "site_id": "4f8ba9f1-328b-cc83-153a-88f7ded30577",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [],
        "preferred_locale": "en",
        "locked_at": "1943-10-20T05:37:30.0Z",
        "created_at": "1967-10-07T13:14:46.0Z",
        "updated_at": "1927-11-20T02:22:48.0Z",
        "deleted_at": "1907-11-04T06:23:02.0Z",
        "last_active_at": "1918-06-09T01:44:42.0Z",
        "email_verified_at": "1967-03-07T07:54:50.0Z",
        "last_check_in": {
          "checked_in_at": "1933-04-11T07:27:05.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "12c4ed04-e8cb-27c4-67c1-808d0bbadbc7",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "dolore labore ex aliqua"
      },
      "members": [
        {
          "customer_id": "d9e7296a-8df1-91a1-5a7d-55d03c5e7fb2",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "d8fb55b4-edf6-602f-09bd-440a93e8ee4f",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "ac9b40ec-33c0-3b04-0059-269bbeb3e3ed",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "77408765-4202-91c7-fb3e-7c1190a413e1",
          "membership_number": "1234567890"
        }
      ],
      "type": {
        "id": "74bd31ca-ba33-3043-5185-9e0f147bb716",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "ex est in",
        "brand_id": "cc115ae4-c6d4-55ad-544f-39fa6238cb52",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "private",
        "minimum_start_date": "1947-03-31T19:28:04.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "70c0e21e-ef8e-efb8-a53d-b43af7349e82",
            "currency": "GBP",
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1893-02-11T23:06:57.0Z",
            "updated_at": "1967-03-02T07:58:25.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1890-07-29T16:34:27.0Z",
        "updated_at": "1936-09-06T03:12:05.0Z",
        "deleted_at": "1920-02-05T09:49:35.0Z"
      },
      "rate": {
        "id": "17ad5789-03cf-d57e-0ebc-e1a7faa55e24",
        "membership_type_id": "3af10cfd-d95e-1555-e806-a59b72053e14",
        "name": "Standard rate",
        "currency": "GBP",
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "default_duration": "P1Y",
        "created_at": "1933-01-27T01:01:19.0Z"
      },
      "status": "needs_attention",
      "source": "app",
      "payment_method": {
        "id": "officia Ut aute sint",
        "type": "card",
        "last_4": "est officia nostrud",
        "status": "revoked",
        "card_brand": "amex"
      },
      "start_date": "1890-05-09T01:44:29.0Z",
      "end_date": "1917-12-13T19:26:25.0Z",
      "created_at": "1949-01-19T06:07:11.0Z",
      "basket_id": "68c3ebfeea9fe1012b0000a2",
      "external_ref": "anim cillum",
      "next_billing_date": "1913-06-14T16:16:11.0Z",
      "next_charge": {
        "id": "86896d4f-17d1-3ed6-9d61-66eb83ef7e8a",
        "amount": 3995,
        "currency": "GBP",
        "status": "pending",
        "billing_period_from": "1941-02-18",
        "billing_period_to": "1960-02-16"
      }
    },
    {
      "id": "c608114b-692e-35d5-a79b-96c6dcf64f1d",
      "site_id": "9eeb8d04-d1dd-5bd0-6089-712b04dff95b",
      "membership_number": "1234567890",
      "customer": {
        "id": "1cca8125-0bfc-e20d-13b1-5befbdd2b595",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1949-12-11",
        "brand_id": "02ac4a61-d6cf-6594-e72f-723ba906f010",
        "site_id": "00e2ff07-017e-cbde-51e1-d9a3ebbce973",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "ee6f3d50-7a38-f03f-43ca-0229356f4bfd",
            "value": "VIP",
            "colour": "ff6634"
          },
          {
            "id": "18efd0a9-a5ff-ef15-9cb9-12e1294424f2",
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1943-11-26T03:24:03.0Z",
        "created_at": "1955-03-15T02:25:13.0Z",
        "updated_at": "1955-03-06T10:52:16.0Z",
        "deleted_at": "1922-04-19T15:48:25.0Z",
        "last_active_at": "1941-09-27T07:06:15.0Z",
        "email_verified_at": "1933-03-24T21:33:03.0Z",
        "last_check_in": {
          "checked_in_at": "1899-10-23T04:38:41.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "6300a334-eb1a-15bb-7ee9-7490321009cf",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "anim ipsum"
      },
      "members": [
        {
          "customer_id": "c4711329-9dec-f521-6db8-7f6441dccbc3"
        },
        {
          "customer_id": "220c828d-f9dd-fa54-cf96-5fa6172d9bbb",
          "membership_number": "1234567890",
          "is_lead": false
        }
      ],
      "type": {
        "id": "10d6c7ed-d721-d483-a998-c53fe4172b08",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "non officia cupidatat aute",
        "brand_id": "6ea4ed0b-1569-e222-7375-5c75e7a1ddf4",
        "offline_payments": false,
        "disable_confirmation_email": true,
        "private": true,
        "visibility": "public",
        "minimum_start_date": "1960-01-10T09:01:46.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "culpa pariatur",
              "cillum consequat",
              "id Excepteur laborum ex"
            ]
          },
          {
            "id": "68017e6e-790b-9e19-ecfa-35ad27aa7f66",
            "membership_type_id": "d2007e8e-abc7-8625-8853-31d931579338",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "in do"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1920-10-20T03:21:20.0Z",
            "updated_at": "1919-05-16T04:09:27.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1957-01-19T13:19:40.0Z",
        "updated_at": "1958-11-29T20:21:24.0Z",
        "deleted_at": "1898-07-23T09:11:56.0Z"
      },
      "rate": {
        "id": "6e2728c4-8377-91f5-5d04-754c8afbf88e",
        "membership_type_id": "cfd258cd-59e4-a835-0dff-9d6750f0dfcb",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "et nostrud elit nisi"
        ],
        "created_at": "1959-09-09T13:54:01.0Z",
        "updated_at": "1909-07-03T14:45:35.0Z"
      },
      "status": "active",
      "source": "app",
      "payment_method": {
        "id": "in",
        "type": "direct_debit",
        "last_4": "deserunt",
        "status": "revoked"
      },
      "start_date": "1909-09-19T08:47:26.0Z",
      "end_date": "1912-08-02T19:21:30.0Z",
      "created_at": "1917-10-24T11:09:05.0Z",
      "next_charge": {
        "id": "e4e3779e-e57b-88ec-eb69-e02d15533971",
        "amount": 3995,
        "currency": "GBP",
        "status": "errored",
        "billing_period_from": "1905-01-05",
        "billing_period_to": "1905-08-13"
      }
    }
  ],
  "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": "bf95a1c1-e1d7-a52d-f543-ee7e38008b71",
    "site_id": "84ff7544-a8fc-49c8-de0c-30fa468042df",
    "membership_number": "1234567890",
    "customer": {
      "id": "773acf9c-4eb1-d1c7-7c51-09ce9fd7aa4f",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1892-01-21",
      "brand_id": "8233a7e6-972e-bbc8-a2a9-1d44419e7a04",
      "site_id": "041f3d40-6d09-d474-efd8-02398c79bf53",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "81d039b6-1627-ca5b-57bd-c9c999e7d791",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "f495cf05-1dad-a743-eddd-49c7201e2100",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "9c74c2d6-c240-cdda-d4e3-2199b402a277",
          "value": "VIP",
          "colour": "ff6634"
        },
        {
          "id": "72ced34f-0551-2d08-a4eb-d4f5015742c2",
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1909-08-04T14:45:21.0Z",
      "created_at": "1941-09-06T14:09:47.0Z",
      "updated_at": "1909-07-05T01:44:23.0Z",
      "deleted_at": "1921-09-05T14:01:28.0Z",
      "last_active_at": "1966-08-26T01:40:39.0Z",
      "email_verified_at": "1920-10-18T19:03:11.0Z",
      "last_check_in": {
        "checked_in_at": "1897-04-28T03:03:24.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "bd24119b-941d-c650-cbf2-d1c14ba82264",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo.jpg"
      },
      "external_ref": "commodo elit"
    },
    "members": [
      {
        "customer_id": "de934d78-e3f3-10df-d268-f9717a164b2a",
        "membership_number": "1234567890",
        "is_lead": true
      },
      {
        "customer_id": "d67b6e64-5b5f-f2ce-eac8-2084ec21ab1b",
        "is_lead": false
      }
    ],
    "type": {
      "id": "9e2fda64-1c2c-e129-5081-b7a052378f16",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "in consectetur minim",
      "brand_id": "d034db97-78ea-7a5d-e1ef-21b8148f49d7",
      "offline_payments": true,
      "disable_confirmation_email": true,
      "private": true,
      "visibility": "public",
      "minimum_start_date": "1957-03-20T03:33:13.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "id": "8f8b55a6-813f-bf0f-a4e4-46009a89aff8",
          "membership_type_id": "6be0add3-5677-0f11-5c5f-b15f026eb753",
          "name": "Standard rate",
          "currency": "GBP"
        },
        {
          "created_at": "1912-01-17T02:06:43.0Z"
        },
        {
          "id": "59b13083-2ed1-4483-d061-1c786fc68d90",
          "membership_type_id": "d2e6e5e3-9660-438a-d0f8-4fb30a30089a",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "tax": 1250
        },
        {
          "id": "2158c9a2-d019-27e6-95e5-60dfd50402ac",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "tax": 1250,
          "billing_frequency": "P1M",
          "processors": [
            "nostrud",
            "sint do anim voluptate laboris"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1892-08-04T01:15:42.0Z",
          "updated_at": "1945-09-23T01:37:33.0Z"
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1897-11-20T01:31:47.0Z",
      "updated_at": "1916-06-20T09:54:23.0Z",
      "deleted_at": "1951-03-31T12:33:27.0Z"
    },
    "rate": {
      "id": "385c2e97-f84b-b733-19e9-0a0ab3c62944",
      "membership_type_id": "363b7122-f5bc-0cfa-28a5-26d20b1eaa79",
      "name": "Standard rate",
      "currency": "GBP",
      "price": 5000,
      "joining_fee": 1000,
      "tax": 1250,
      "billing_frequency": "P1M",
      "processors": [],
      "default_duration": "P1Y",
      "created_at": "1936-10-22T08:42:08.0Z",
      "updated_at": "1908-12-24T12:43:27.0Z"
    },
    "status": "upcoming",
    "source": "unknown",
    "payment_method": {
      "id": "cillum minim sit eu velit",
      "type": "direct_debit",
      "last_4": "tempor enim",
      "status": "revoked"
    },
    "start_date": "1948-09-01T13:50:38.0Z",
    "end_date": "1903-09-20T20:14:43.0Z",
    "created_at": "1919-06-08T08:40:49.0Z",
    "basket_id": "68c3ebfeea9fe1012b0000a3",
    "external_ref": "laboris eiusmod Lorem quis elit",
    "next_billing_date": "1952-05-17T05:15:32.0Z",
    "next_charge": {
      "id": "98151d24-5bd5-97b0-e839-8de24cca8d25",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "1921-10-11",
      "billing_period_to": "1910-03-12"
    },
    "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": "d1b5f3cf-1071-eda0-f890-973d4385f569",
    "membership": {
      "id": "f617617f-c888-e90d-f7b9-35bb6679e383",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "dfb0556d-2c22-a1a0-3944-a34b2ab8872e"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "Excepteur esse sunt non laborum",
    "can_download_receipt": false,
    "amount_refunded": "irure pariatur quis",
    "refunded": "sunt",
    "refunds": [],
    "site_id": "2fc6ddd3-6a16-f09e-beba-a9ec13118a00",
    "billing_period_from": "1962-02-04",
    "billing_period_to": "1945-07-05",
    "processing_at": "1964-10-18T22:55:48.0Z",
    "created_at": "1913-05-14T04:12:10.0Z",
    "updated_at": "1960-04-05T20:32:52.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": "b17544f7-8cd4-f9dd-a213-85dfaecf463f",
    "membership": {
      "id": "5d665aca-8f69-7e10-ff9d-5f9a008dfab0",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "d7be0e24-cb88-02f8-44dc-f51b1e5773e0",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "last_4": 4001
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "quis",
    "can_download_receipt": true,
    "amount_refunded": "consectetur",
    "refunded": "do veniam",
    "refunds": [
      {
        "id": "78e1c9f4-d393-a851-0962-906a35efad98",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "a812a9ef-9645-608e-2fd2-cb96ab952b61",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1890-11-25T10:01:26.0Z",
        "updated_at": "1905-12-22T02:42:24.0Z"
      },
      {
        "id": "3c18fb12-42d2-a66e-2bc6-6631f4d06486",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "90ccd023-d7d2-1f2b-b63f-24a68ca08320",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1946-11-02T16:49:15.0Z",
        "updated_at": "1964-08-25T10:39:17.0Z"
      }
    ],
    "site_id": "3ed71bdf-704f-7998-9474-ee97819c3137",
    "billing_period_from": "1910-06-27",
    "billing_period_to": "1943-04-27",
    "processing_at": "1957-01-22T17:15:47.0Z",
    "created_at": "1911-06-11T23:28:27.0Z",
    "updated_at": "1954-05-19T10:33:32.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": "16d6139f-c65f-be0f-dd14-b3e640cb1fd1",
    "membership": {
      "id": "33897c80-ab7f-c7b5-a567-f19e455871c9",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "84e3c49c-fae2-385a-6504-63dadb996a3f",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "68c3ebfeea9fe1012b0000a4"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "consectetur dolore minim sunt",
    "can_download_receipt": false,
    "amount_refunded": "consequat deserunt",
    "refunded": "ex",
    "refunds": [],
    "site_id": "d3a23f3e-5062-d61f-0baf-766c693dda05",
    "billing_period_from": "1916-04-14",
    "billing_period_to": "1940-08-29",
    "processing_at": "1955-12-03T14:35:28.0Z",
    "created_at": "1912-12-24T15:29:36.0Z",
    "updated_at": "1963-01-25T01:57:09.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}