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": "893adeab-5bca-28ec-ee8f-5c69851955b2",
      "site_id": "8dc268a0-917c-4a8d-775f-47edd49c67e1",
      "membership_number": "1234567890",
      "customer": {
        "id": "ec09b355-8b21-5269-1f46-bf2da3db8292",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1968-01-13",
        "brand_id": "a9933502-45a8-46c7-136b-dd290c1caa0b",
        "site_id": "cddb086f-fbe7-4592-8481-e54ead4b8ffd",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "7bd5a5d9-65e4-0be6-906a-07ed973ffe5d",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "fd493e79-3ee8-b0a6-331b-c43dfbe2dfdd",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "296ec4f8-f4e9-aab8-59b1-e3bdbd6a7725",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1935-09-27T03:20:19.0Z",
        "created_at": "1923-04-26T16:57:50.0Z",
        "updated_at": "1958-09-15T15:36:08.0Z",
        "deleted_at": "1905-10-24T18:42:17.0Z",
        "last_active_at": "1944-09-14T12:40:58.0Z",
        "email_verified_at": "1958-12-06T05:20:08.0Z",
        "last_check_in": {
          "checked_in_at": "1951-01-27T06:24:33.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "9114e76b-423e-7104-5339-33cf3b47d7d8",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "dolor minim adipisicing"
      },
      "members": [],
      "type": {
        "id": "be8012b8-595a-2541-aae4-3c3de13399ed",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "Ut dolor commodo",
        "brand_id": "81d724d4-1af1-2020-eb3e-ab96b8eb2c4c",
        "offline_payments": true,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "public",
        "minimum_start_date": "1930-04-23T17:15:05.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "39b287da-9ff3-1f28-b3ee-bdcea1b28cc8",
            "membership_type_id": "37b34d2c-e6cf-d058-f62f-8b6e7bd57698",
            "name": "Standard rate",
            "currency": "GBP",
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1917-10-12T08:38:14.0Z",
            "updated_at": "1900-05-11T09:54:11.0Z"
          },
          {
            "id": "179ed4c7-57c1-2e95-c5f2-a2e154138e04",
            "membership_type_id": "0c8f658d-caa9-8905-c9ac-8d71744078af",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "id",
              "ut Excepteur",
              "fugiat"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1895-03-02T04:05:15.0Z"
          },
          {
            "id": "f2c05f87-a57e-4701-0d90-4bf3c85ca550",
            "membership_type_id": "026edbfd-bf24-cda8-d46e-cae4fd845b3f",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "commodo sint dolor minim ut",
              "exercitation",
              "ea Lorem incididunt officia"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1922-12-07T15:01:50.0Z",
            "updated_at": "1969-07-01T14:17:48.0Z"
          },
          {
            "membership_type_id": "6e6c4cf4-70f4-6ddb-5c28-8265430a7b34",
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "private": true
          },
          {
            "id": "d56f1e89-5190-6b7f-c623-45d80c832347",
            "name": "Standard rate",
            "tax": 1250,
            "processors": [
              "est",
              "reprehenderit elit minim sit",
              "proident deserunt minim",
              "cupidatat"
            ],
            "created_at": "1958-12-23T02:12:52.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1924-08-12T01:02:19.0Z",
        "updated_at": "1896-02-14T15:01:44.0Z",
        "deleted_at": "1921-05-05T18:59:53.0Z"
      },
      "status": "upcoming",
      "payment_method": {
        "id": "et dolore dolor sed dolor",
        "type": "card",
        "status": "revoked",
        "card_brand": "amex"
      },
      "next_billing_date": "1914-01-17T06:16:36.0Z",
      "attention_reason": "payment_outstanding"
    },
    {
      "id": "2591c949-381d-eb8a-1b1e-b18fa4314974",
      "site_id": "19572a10-a8dc-d883-c478-d3a004013cff",
      "membership_number": "1234567890",
      "customer": {
        "id": "e0b6a64d-6dac-06a7-f1b6-6d3331bea932",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1914-03-23",
        "brand_id": "d1731adb-e86c-7b76-5c72-8d51db28626d",
        "site_id": "4afa13b4-c2dd-297c-7a5d-363cf2107c0d",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [],
        "preferred_locale": "en",
        "locked_at": "1939-09-22T15:35:03.0Z",
        "created_at": "1966-02-19T03:14:22.0Z",
        "updated_at": "1899-04-15T21:43:52.0Z",
        "deleted_at": "1928-09-12T08:55:39.0Z",
        "last_active_at": "1935-09-18T16:52:02.0Z",
        "email_verified_at": "1901-06-25T22:52:36.0Z",
        "last_check_in": {
          "checked_in_at": "1907-05-22T03:56:35.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "87ca68b4-a96e-da20-1d75-012058102d10",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "laboris mollit sint"
      },
      "members": [],
      "type": {
        "id": "bf30ab4f-34fe-55b0-b768-e9e877b765fd",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "reprehenderit aliqua",
        "brand_id": "ae00495a-ab8a-9c40-fcc0-882079e7b361",
        "offline_payments": true,
        "disable_confirmation_email": false,
        "private": false,
        "visibility": "private",
        "minimum_start_date": "1951-01-27T01:40:23.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1946-03-27T06:29:14.0Z",
        "updated_at": "1900-02-22T21:52:02.0Z",
        "deleted_at": "1899-03-08T10:28:21.0Z"
      },
      "rate": {
        "tax": 1250,
        "default_duration": "P1Y",
        "private": true
      },
      "status": "needs_attention",
      "source": "import",
      "payment_method": {
        "id": "labore Duis consectetur magna Excepteur",
        "type": "card",
        "status": "revoked"
      },
      "start_date": "1899-03-25T04:11:29.0Z",
      "end_date": "1898-12-01T14:53:06.0Z"
    },
    {
      "id": "aacf519e-2328-8401-2b12-687cc5a0edd9",
      "site_id": "f3bd68dd-74e5-b772-5ebc-47f5423f633a",
      "membership_number": "1234567890",
      "customer": {
        "id": "aa010d71-b2ca-fec8-b1b8-f8db307822f5",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1958-12-20",
        "brand_id": "e507b86f-2d65-96ba-31fe-722b3839d5e7",
        "site_id": "cfc4d465-befb-3442-1384-dfb81732af99",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "f7dfd76f-24f9-c69b-a400-6e9f02449b36",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "7c7ce97b-6da3-57ed-98c1-9da4df1a81c4",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "2a462201-5a39-1a4e-1339-fb6cb54c23ed",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "d7eba4b6-8d55-7f9c-0948-3d74b6422fe0",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1900-01-02T07:07:08.0Z",
        "created_at": "1940-02-11T10:15:03.0Z",
        "updated_at": "1903-02-07T01:57:55.0Z",
        "deleted_at": "1922-09-13T21:14:45.0Z",
        "last_active_at": "1890-02-11T17:26:51.0Z",
        "email_verified_at": "1963-07-09T07:17:02.0Z",
        "last_check_in": {
          "checked_in_at": "1962-12-15T20:41:28.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "a8323249-9474-fe4f-2e6c-757537380a1f",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "labore"
      },
      "members": [
        {
          "customer_id": "3e635e17-4af7-4424-dc20-fca223ef1142"
        },
        {
          "customer_id": "e7c8a712-9cc1-2e86-cd31-92c75e69c668",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "70df3292-8e3c-d08c-9bca-3a52502b9ed9",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "membership_number": "1234567890"
        },
        {
          "customer_id": "460395a9-c485-0866-8c87-9a39a26cc9e6",
          "membership_number": "1234567890"
        }
      ],
      "rate": {
        "membership_type_id": "0e83316c-1ea0-c0ff-9cbc-1019d5782e37",
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "tax": 1250,
        "billing_frequency": "P1M",
        "processors": [
          "dolore in eu nisi minim",
          "consequat nisi in et",
          "dolor enim sit magna Ut",
          "nostrud"
        ],
        "default_duration": "P1Y",
        "private": true,
        "created_at": "1946-12-15T03:08:27.0Z",
        "updated_at": "1890-10-02T08:06:33.0Z"
      },
      "status": "expired",
      "source": "self_signup",
      "start_date": "1897-11-28T01:14:02.0Z",
      "end_date": "1951-04-01T20:16:04.0Z",
      "basket_id": "693bf89832af25012b00009d",
      "external_ref": "tempor qui",
      "next_billing_date": "1903-04-04T04:22:47.0Z",
      "next_charge": {
        "id": "9854e3ed-74d6-ddfb-c326-56e8d08b069a",
        "amount": 3995,
        "currency": "GBP",
        "status": "processing",
        "billing_period_from": "1955-11-08",
        "billing_period_to": "1965-11-18"
      },
      "attention_reason": "payment_outstanding"
    },
    {
      "id": "e4ce9588-cc31-2d8e-42a9-2043e935e0f8",
      "customer": {
        "id": "1148bfbe-f7ec-106b-6ac1-ae19ac5bc168",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1909-06-11",
        "brand_id": "f18b285f-0ab5-d3a8-91e4-08b198e6ecb6",
        "site_id": "7dc4af80-462f-2406-715e-bea9e31c363c",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "e9e354cf-79ad-6c12-ce0a-9dfe1bca5728",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "1cf14aba-b814-93bc-6ead-80ceb93ee0c0",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "fbc34e8e-1eea-e66a-7f10-f6eb75c17350",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "6d6385f1-22bc-122b-d152-16e698ba3f59",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "b906000a-5ee5-89fc-b99f-8a35c9b2ee68",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1909-11-12T08:31:50.0Z",
        "created_at": "1955-01-31T15:06:09.0Z",
        "updated_at": "1948-11-20T19:52:19.0Z",
        "deleted_at": "1969-07-24T06:52:10.0Z",
        "last_active_at": "1969-07-21T11:35:10.0Z",
        "email_verified_at": "1920-01-09T02:31:41.0Z",
        "last_check_in": {
          "checked_in_at": "1935-07-23T10:15:23.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "81cba4e4-3859-6fe6-737e-2cb2864bbd76",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "Duis"
      },
      "members": [
        {
          "customer_id": "3b7c105f-b03c-c0bc-a9ed-cea7e23551a0",
          "membership_number": "1234567890"
        }
      ],
      "type": {
        "id": "40ffe89c-2d69-6c13-a4a8-23e12687369f",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "Excepteur voluptate",
        "brand_id": "04b820db-6a47-cbfe-1849-a493e3b4aaf0",
        "offline_payments": false,
        "disable_confirmation_email": false,
        "private": true,
        "visibility": "private",
        "minimum_start_date": "1943-12-27T16:48:42.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "5ae16e5e-92c6-4bc9-6af6-338fdc85b722",
            "name": "Standard rate",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [],
            "default_duration": "P1Y",
            "created_at": "1944-03-31T01:50:59.0Z"
          },
          {
            "id": "109ddb12-97ea-bb0b-fb1a-e13bd9db1997",
            "name": "Standard rate",
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "aute Ut",
              "consequat ut",
              "ex"
            ],
            "default_duration": "P1Y",
            "updated_at": "1904-10-16T21:03:35.0Z"
          },
          {
            "id": "9b14a228-96c3-2c94-5165-525eb24761b0",
            "membership_type_id": "ae668d30-d937-8d57-3cec-7e15453f4dd6",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "sint fugiat sunt",
              "in consectetur",
              "consectetur Lorem est ut"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1915-11-07T21:07:28.0Z",
            "updated_at": "1967-04-05T01:57:58.0Z"
          },
          {
            "id": "3e8b7990-064e-e6fb-4bf5-e60c4747fc95",
            "membership_type_id": "b63d12ee-4d20-1be3-fc74-15302e811bb4",
            "currency": "GBP",
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "processors": [
              "dolor consequat incididunt Duis",
              "amet irure mollit esse"
            ],
            "created_at": "1967-08-01T16:28:32.0Z",
            "updated_at": "1959-02-28T04:52:23.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1969-01-29T11:48:48.0Z",
        "updated_at": "1943-02-24T05:35:49.0Z",
        "deleted_at": "1933-05-15T07:21:17.0Z"
      },
      "source": "app",
      "payment_method": {
        "type": "card"
      },
      "start_date": "1966-08-04T12:16:29.0Z",
      "end_date": "1953-11-25T08:55:33.0Z",
      "created_at": "1910-08-17T06:47:25.0Z",
      "basket_id": "693bf89832af25012b00009e",
      "next_billing_date": "1908-08-19T09:36:32.0Z"
    }
  ],
  "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": "3e949ce7-35e3-0cd9-943b-6b48a393a830",
    "site_id": "dc4ae66e-124b-91b8-7325-662ea3ae2cb6",
    "membership_number": "1234567890",
    "customer": {
      "id": "71350070-13bb-c1a4-9154-4c13032199fd",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1960-10-26",
      "brand_id": "4440780f-94ff-7497-7517-24ca7d003906",
      "site_id": "2b100cea-fdcb-2339-978e-2541d943d2d2",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "00b104e0-189a-5165-00b4-75334b318755",
          "name": "VIP",
          "color": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1906-01-06T10:32:52.0Z",
      "created_at": "1969-02-08T10:08:07.0Z",
      "updated_at": "1969-08-18T10:55:29.0Z",
      "deleted_at": "1950-10-04T01:03:49.0Z",
      "last_active_at": "1942-08-01T03:48:12.0Z",
      "email_verified_at": "1904-12-05T05:50:01.0Z",
      "last_check_in": {
        "checked_in_at": "1932-10-27T21:44:27.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "c784b433-39fb-7220-be12-712e591b586d",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "external_ref": "aliquip"
    },
    "members": [
      {
        "customer_id": "4f92f3e9-0f66-81aa-a9c2-4b8fc1e2f8ca",
        "membership_number": "1234567890",
        "is_lead": false
      }
    ],
    "type": {
      "id": "8f949a2b-0649-5732-1710-388d5693ce1a",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "Duis eiusmod quis",
      "brand_id": "f15ee51a-4c65-017e-c46d-aa682122714d",
      "offline_payments": true,
      "disable_confirmation_email": true,
      "private": true,
      "visibility": "link_only",
      "minimum_start_date": "1907-05-16T19:46:30.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "currency": "GBP",
          "price": 5000,
          "tax": 1250,
          "private": true
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1953-10-16T08:32:18.0Z",
      "updated_at": "1895-08-12T04:24:52.0Z",
      "deleted_at": "1963-08-28T07:01:20.0Z"
    },
    "next_charge": {
      "id": "89610c42-a182-27b6-93d6-226004c0c8a3",
      "amount": 3995,
      "currency": "GBP",
      "status": "succeeded",
      "billing_period_from": "1894-08-25",
      "billing_period_to": "1908-06-10"
    },
    "attention_reason": "site_id"
  }
}
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": "15966721-1192-cb47-47cd-280d9163bc8d",
    "membership": {
      "id": "af7a3f5f-9bf1-a804-9310-a726ca10279f",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "a357a959-6553-987c-2f22-a45842576250",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "693bf89832af25012b00009f"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "irure exercitation Ut quis",
    "can_download_receipt": false,
    "amount_refunded": "aliquip fugiat amet",
    "refunded": "fugiat",
    "refunds": [],
    "site_id": "ed8378bc-4166-e142-1dec-57c9bb113d57",
    "billing_period_from": "1924-05-19",
    "billing_period_to": "1947-07-12",
    "processing_at": "1932-08-27T05:53:45.0Z",
    "created_at": "1917-07-18T05:34:37.0Z",
    "updated_at": "1964-05-22T08:58:41.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": "9e58fc68-e963-6fcb-548b-e54888301038",
    "membership": {
      "id": "ebf09a9c-77a6-daca-7f00-ca08e6b6d359",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "b6e3b058-315b-d842-6426-382ed0bcdf80",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "693bf89832af25012b0000a0"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "adipisicing laborum",
    "can_download_receipt": true,
    "amount_refunded": "elit irure Lorem tempor",
    "refunded": "quis nostrud reprehenderit tempor",
    "refunds": [
      {
        "id": "00996c8b-2e4b-5ce8-c5d2-4f4aca86edbc",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "650481b0-7078-28c6-0148-3816ad0eb31e",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1920-11-24T07:13:34.0Z",
        "updated_at": "1921-09-30T12:30:04.0Z"
      },
      {
        "id": "f2c408a7-13f2-98a3-ab22-6cd5f9e1aab8",
        "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": "1936-10-09T07:25:26.0Z",
        "updated_at": "1946-03-21T23:26:23.0Z"
      },
      {
        "id": "d678ddb9-7700-31f9-2a1c-3f1bdd541a93",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "591784b0-2715-06e8-7cdd-9bd96a299e1f",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1958-08-30T02:50:48.0Z",
        "updated_at": "1910-11-28T22:06:34.0Z"
      },
      {
        "id": "c08bdf27-e9d8-4a25-814a-3e102ef268c7",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "3aa0ee44-287e-dda3-9b66-116fe12d6c47",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1893-07-20T06:39:37.0Z",
        "updated_at": "1937-07-11T22:28:14.0Z"
      },
      {
        "id": "3f958018-ea83-9339-fdcf-abf0737c14ac",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "4533361c-cb49-e50e-b529-945551bee762",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1953-08-27T13:21:58.0Z",
        "updated_at": "1955-01-27T11:51:14.0Z"
      }
    ],
    "site_id": "eb388001-8d7e-07ee-7b49-354d5f33f91a",
    "billing_period_from": "1919-06-16",
    "billing_period_to": "1952-12-20",
    "processing_at": "1904-02-27T23:14:43.0Z",
    "created_at": "1914-02-03T05:48:29.0Z",
    "updated_at": "1918-08-30T19:54:11.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": "64accc45-851f-0261-26c3-d17f436407c6",
    "membership": {
      "id": "7fdda2a1-a721-d7b0-f3c8-1427e1d6fe31",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "9243c875-fb51-0ada-3fde-59b9cdb62acb"
    },
    "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": "consequat",
    "can_download_receipt": true,
    "amount_refunded": "sunt",
    "refunded": "fugiat non sed",
    "refunds": [
      {
        "id": "9a7e1fba-d171-1aac-b4e3-80f5aefcfdd0",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "f4a0ed0c-0486-4dfc-3f16-19064a267e36",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1920-12-03T05:07:24.0Z",
        "updated_at": "1916-09-29T10:18:37.0Z"
      }
    ],
    "site_id": "ec55380c-c38b-3afd-5249-004baa93f26f",
    "billing_period_from": "1896-02-26",
    "billing_period_to": "1944-05-21",
    "processing_at": "1903-12-17T18:18:22.0Z",
    "created_at": "1958-12-07T23:58:50.0Z",
    "updated_at": "1915-08-21T20:37:59.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}