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": [
    {
      "membership_number": "1234567890",
      "customer": {
        "id": "b3ac1330-9de3-82e0-e125-15febe933240",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1966-06-12",
        "brand_id": "f79b7832-1738-6844-32e0-e971f78936bf",
        "site_id": "b0636350-37ad-3625-2402-b9e7484d123d",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "a46d66ee-cc1d-e4eb-e350-fa6af35d51aa",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "b0879df2-efe5-697b-897f-96a1a1075a61",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "be5b7186-27db-2394-dbb0-193ded0d7144",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "cfa30dee-8592-36ff-b0fe-b269110f0e4b",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "93bbb39a-1d77-d581-f945-5cdd0de70e63",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1935-02-07T11:19:15.0Z",
        "created_at": "1928-06-17T01:37:25.0Z",
        "updated_at": "1937-02-01T13:07:01.0Z",
        "deleted_at": "1938-10-07T19:04:02.0Z",
        "last_active_at": "1928-08-21T09:34:21.0Z",
        "email_verified_at": "1909-12-16T04:16:48.0Z",
        "last_check_in": {
          "checked_in_at": "1920-12-27T08:47:42.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "a3d82a7f-2f02-5e25-acc8-46d31d1b8eff",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "eiusmod voluptate est"
      },
      "members": [
        {
          "customer_id": "d638e9fc-a9aa-446d-8cfd-913380fbda7e",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "466d508e-710a-5924-b31e-b47f43b8786f",
          "is_lead": false
        },
        {
          "customer_id": "314551fe-1540-fd06-4eac-37358b47be7e",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "18cdfd9c-6a37-0400-4944-059b3273847e",
          "membership_number": "1234567890",
          "is_lead": true
        },
        {
          "customer_id": "0469e237-d7e7-9e9b-07e6-4f592d3d8387",
          "membership_number": "1234567890"
        }
      ],
      "type": {
        "id": "e77cf94f-aadc-0edf-f4cd-f7e52fbd500f",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "magna",
        "brand_id": "912b2908-c907-1268-a573-1ee7468cf94c",
        "offline_payments": true,
        "disable_confirmation_email": true,
        "private": false,
        "visibility": "public",
        "minimum_start_date": "1910-12-22T09:17:42.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "2d20f6d7-ebdf-6927-a7fc-6a6a9730f7bc",
            "membership_type_id": "c1ca29bb-e08b-4350-e87c-71caee26427b",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "Excepteur ex anim",
              "elit dolore mollit veniam Lorem",
              "occaecat officia",
              "nostrud magna aliquip officia"
            ]
          },
          {
            "membership_type_id": "b044b1ba-a797-b085-8d1b-39e79ab540cf",
            "name": "Standard rate",
            "currency": "GBP",
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "laborum eu in Excepteur id",
              "adipisicing cillum id ad",
              "aliqua"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1905-05-09T20:04:32.0Z",
            "updated_at": "1905-12-19T12:29:13.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1914-07-25T05:32:42.0Z",
        "updated_at": "1940-12-03T10:11:54.0Z",
        "deleted_at": "1920-06-23T21:51:10.0Z"
      },
      "status": "reserved",
      "payment_method": {
        "id": "exercitation nulla ullamco nostrud ea",
        "type": "direct_debit",
        "last_4": "elit sed laboris",
        "status": "revoked"
      },
      "end_date": "1941-04-24T19:42:02.0Z",
      "created_at": "1903-02-19T11:15:08.0Z",
      "next_billing_date": "1897-09-05T20:12:12.0Z",
      "attention_reason": "payment_disputed"
    },
    {
      "membership_number": "1234567890",
      "members": [
        {
          "customer_id": "81c01dd0-d1e1-95db-0337-a375c9da0591",
          "is_lead": false
        },
        {
          "customer_id": "9def54dc-43bf-e438-a595-5714c0d4d9f9",
          "is_lead": false
        },
        {
          "membership_number": "1234567890"
        },
        {
          "customer_id": "5acd6340-6873-ae8a-c230-d18e6c924b5c",
          "membership_number": "1234567890",
          "is_lead": false
        },
        {
          "customer_id": "8be448a6-aef6-6565-d274-e8b922cfc8db",
          "membership_number": "1234567890"
        }
      ],
      "rate": {
        "tax": 1250,
        "billing_frequency": "P1M",
        "private": true
      },
      "status": "active",
      "start_date": "1912-09-20T10:39:56.0Z",
      "end_date": "1919-05-14T13:53:32.0Z",
      "created_at": "1942-04-29T01:27:44.0Z",
      "basket_id": "6937ee62a5ad120169000093",
      "next_billing_date": "1950-02-10T06:55:35.0Z",
      "next_charge": {
        "id": "95f707c1-cd90-25d9-4bc2-5d287a7bb8f7",
        "amount": 3995,
        "currency": "GBP",
        "status": "succeeded",
        "billing_period_from": "1933-02-26",
        "billing_period_to": "1918-10-12"
      }
    },
    {
      "membership_number": "1234567890",
      "customer": {
        "id": "97bb457c-8268-f306-6454-9e75e73d5ab8",
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "dob": "1896-04-17",
        "brand_id": "d24026ed-a7cb-6e68-efcc-2e9c02fa72a2",
        "site_id": "d239aea0-636a-c11f-bd3e-c35e88612fb9",
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "id": "f039e011-9bd5-d67e-f988-49a0f31daa99",
            "name": "VIP",
            "color": "ff6634"
          },
          {
            "id": "6b81004d-1d07-738f-5a21-744cfacbafe7",
            "name": "VIP",
            "color": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "locked_at": "1928-07-03T19:44:14.0Z",
        "created_at": "1944-12-21T21:03:07.0Z",
        "updated_at": "1947-11-21T19:16:51.0Z",
        "deleted_at": "1912-03-06T22:20:05.0Z",
        "last_active_at": "1915-05-09T01:13:15.0Z",
        "email_verified_at": "1948-11-24T07:29:59.0Z",
        "last_check_in": {
          "checked_in_at": "1964-09-14T11:14:22.0Z",
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "id": "f82228e8-2ace-7a1f-190b-14df8925f79c",
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo.jpg"
        },
        "external_ref": "fugiat quis"
      },
      "type": {
        "id": "6ffb31dd-a2ff-7542-4349-7e8043e4c86f",
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "terms": "quis aute pariatur",
        "brand_id": "3823cc0b-dad8-ab20-ea4f-96e27d849b05",
        "offline_payments": true,
        "disable_confirmation_email": false,
        "private": false,
        "visibility": "link_only",
        "minimum_start_date": "1913-05-06T21:32:11.0Z",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "id": "ea84959d-f4fd-9942-3a16-1e2d9265e9ca",
            "membership_type_id": "f7fa26b9-55ab-8fda-7000-d86ef37cd066",
            "name": "Standard rate",
            "currency": "GBP",
            "joining_fee": 1000,
            "processors": [
              "reprehenderit enim",
              "laborum ullamco",
              "reprehenderit laborum"
            ],
            "private": true
          },
          {
            "id": "897cd971-2250-89c9-1289-a0de01a73ddf",
            "membership_type_id": "f6b2c6f3-341d-44bc-3cba-e958473ca622",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "in do ea nostrud",
              "enim elit velit veniam aliquip"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1897-01-01T07:15:42.0Z",
            "updated_at": "1931-04-08T10:04:32.0Z"
          },
          {
            "id": "86b387a3-d0ba-2aff-c6c7-cd80b862835b",
            "membership_type_id": "935f6abd-2406-f514-95cc-7b3f70e450f6",
            "name": "Standard rate",
            "currency": "GBP",
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "fugiat Ut",
              "ad",
              "incididunt",
              "ullamco dolore Lorem nostrud"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1956-11-30T01:32:14.0Z",
            "updated_at": "1933-04-15T02:50:16.0Z"
          },
          {
            "id": "c252f581-9453-d172-f5ab-e6ac6516fda9",
            "membership_type_id": "b20070d3-dda7-01eb-5220-bcd8a2192524",
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "tax": 1250,
            "billing_frequency": "P1M",
            "processors": [
              "mollit nulla",
              "tempor sunt consectetur",
              "officia",
              "officia in",
              "do"
            ],
            "default_duration": "P1Y",
            "private": true,
            "created_at": "1896-09-02T22:42:30.0Z",
            "updated_at": "1911-07-13T11:59:55.0Z"
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY",
        "created_at": "1957-11-23T01:10:23.0Z",
        "updated_at": "1962-09-27T09:09:27.0Z",
        "deleted_at": "1946-11-15T14:09:20.0Z"
      },
      "status": "expired",
      "source": "unknown",
      "end_date": "1941-12-22T22:11:08.0Z",
      "basket_id": "6937ee62a5ad120169000094",
      "external_ref": "tempor sunt et ut consectetur",
      "next_charge": {
        "id": "bf32047b-01df-1fec-2992-a073119b6ea1",
        "amount": 3995,
        "currency": "GBP",
        "status": "failed",
        "billing_period_from": "1929-11-02",
        "billing_period_to": "1950-11-30"
      },
      "attention_reason": "setup_unpaid"
    }
  ],
  "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": "540c58cd-1374-f428-da53-b8cbf7dfd8d7",
    "site_id": "c946a8e3-dc78-0e1f-2cf8-ce834325968f",
    "membership_number": "1234567890",
    "customer": {
      "id": "73442ddf-13f5-379c-1034-5f571a5a2c09",
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "dob": "1929-04-19",
      "brand_id": "08af6f9c-44ab-e06c-d790-bd5fdf48ccd8",
      "site_id": "b516519b-1d10-bd14-ff75-3da764aa4771",
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "id": "47a762e8-d2a1-797a-e4d4-359cf5090e69",
          "name": "VIP",
          "color": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "locked_at": "1941-01-04T01:01:05.0Z",
      "created_at": "1947-11-03T19:04:58.0Z",
      "updated_at": "1940-07-01T11:41:45.0Z",
      "deleted_at": "1941-09-27T05:54:22.0Z",
      "last_active_at": "1891-11-18T12:32:18.0Z",
      "email_verified_at": "1897-08-04T22:11:49.0Z",
      "last_check_in": {
        "checked_in_at": "1895-10-12T20:22:38.0Z",
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "id": "086c74c3-29e8-8cb6-4c89-beadb8a91d99",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo.jpg"
      },
      "external_ref": "elit"
    },
    "members": [],
    "type": {
      "id": "59072fb0-644d-0eda-6e23-3f2727471991",
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "terms": "in aliqua nostrud",
      "brand_id": "456ce918-0d50-d311-ce58-a09e3c8212ec",
      "offline_payments": false,
      "disable_confirmation_email": true,
      "private": false,
      "visibility": "private",
      "minimum_start_date": "1937-03-09T19:02:58.0Z",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "id": "e7f3ad4c-3af8-24bb-202b-ce54509aa3b0",
          "membership_type_id": "62de77be-47d5-9d4c-4e9a-0a60772c625b",
          "name": "Standard rate",
          "currency": "GBP",
          "joining_fee": 1000,
          "tax": 1250,
          "billing_frequency": "P1M",
          "processors": [
            "sunt magna cillum ea minim",
            "incididunt commodo consectetur cupidatat",
            "dolore",
            "ipsum sed fugiat incididunt"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1948-01-31T11:14:13.0Z",
          "updated_at": "1925-03-07T16:42:18.0Z"
        },
        {
          "id": "6f7b99bb-6d49-f690-c499-1e3c994cdec8",
          "membership_type_id": "6b345595-cb38-68d3-3760-3f781648c619",
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "tax": 1250,
          "private": true
        },
        {
          "id": "bf4f2b28-bcda-51fe-e36b-3d04e3deb0fd",
          "membership_type_id": "e19458fe-c2fe-dc65-c39f-87d7054a8c25",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "tax": 1250,
          "billing_frequency": "P1M",
          "default_duration": "P1Y",
          "created_at": "1895-04-03T08:08:07.0Z",
          "updated_at": "1950-11-10T09:42:11.0Z"
        },
        {
          "id": "a3b73ea7-1196-09dd-f2c4-842f7b8d7dde",
          "membership_type_id": "c6483a1f-7a6b-a07f-7faf-fe832b40ac46",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "tax": 1250,
          "billing_frequency": "P1M",
          "processors": [
            "dolor incididunt",
            "id"
          ],
          "default_duration": "P1Y",
          "private": true,
          "created_at": "1946-10-19T02:48:29.0Z",
          "updated_at": "1931-09-08T03:23:45.0Z"
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY",
      "created_at": "1964-05-27T01:13:13.0Z",
      "updated_at": "1915-09-23T16:11:09.0Z",
      "deleted_at": "1945-12-03T19:23:14.0Z"
    },
    "rate": {
      "id": "f7d07910-f2cd-ff75-2558-f30205cd223a",
      "membership_type_id": "4d29a32b-d5f2-6c5d-a27b-021bf1cb188b",
      "name": "Standard rate",
      "currency": "GBP",
      "price": 5000,
      "joining_fee": 1000,
      "tax": 1250,
      "billing_frequency": "P1M",
      "processors": [
        "et ullamco non",
        "pariatur",
        "deserunt",
        "magna pariatur ut cillum mollit"
      ],
      "default_duration": "P1Y"
    },
    "status": "needs_attention",
    "source": "unknown",
    "payment_method": {
      "id": "do deserunt quis nisi",
      "type": "card",
      "status": "revoked"
    },
    "start_date": "1948-06-29T07:27:21.0Z",
    "end_date": "1935-11-16T01:31:23.0Z",
    "created_at": "1893-03-02T17:05:20.0Z",
    "basket_id": "6937ee62a5ad120169000095",
    "external_ref": "cupidatat in esse velit",
    "next_billing_date": "1929-10-27T02:19:22.0Z",
    "next_charge": {
      "id": "1415c8a6-fd29-122c-b49b-5b15347b8e98",
      "amount": 3995,
      "currency": "GBP",
      "status": "awaiting_approval",
      "billing_period_from": "1946-02-06",
      "billing_period_to": "1962-02-23"
    },
    "attention_reason": "payment_outstanding"
  }
}
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": "64d9a4d3-45be-1f1d-8bb2-e3564eae3ce8",
    "membership": {
      "id": "15c73a31-0c62-caec-40d3-1021ff1248be",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "2e52934a-e8b1-7f87-56bb-94c3e6218bd6",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "processor_type_id": "6937ee62a5ad120169000096"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "nostrud ullamco",
    "can_download_receipt": true,
    "amount_refunded": "officia laborum sint ut",
    "refunded": "mollit id",
    "refunds": [
      {
        "id": "45a131a4-fe21-8d41-06e0-f753928042b4",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "8aa6b4c2-b7e0-eb2c-82f6-deb592ffed79",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1894-07-03T23:19:12.0Z",
        "updated_at": "1927-03-18T20:14:14.0Z"
      },
      {
        "id": "e723a647-4ea2-7035-353e-489e92cbd3a9",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "aa21b757-b026-5597-89ca-e4cf8f619995",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1953-12-22T16:25:33.0Z",
        "updated_at": "1938-07-05T19:11:42.0Z"
      },
      {
        "id": "89bcc015-c10a-1782-9aed-1d8abe19e22c",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "bf76d56b-78c8-ff73-4dfb-d44e4f7164f4",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1934-03-29T18:10:48.0Z",
        "updated_at": "1917-08-14T19:56:44.0Z"
      }
    ],
    "site_id": "5d577bfc-cf17-b805-d868-4adbbb721892",
    "billing_period_from": "1915-01-13",
    "billing_period_to": "1899-01-08",
    "processing_at": "1900-02-01T09:13:04.0Z",
    "created_at": "1957-12-07T08:37:42.0Z",
    "updated_at": "1943-05-23T04:47:27.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": "bbcc7d14-02d6-fd5b-e1d1-f4c5e7b80d6d",
    "membership": {
      "id": "036cdcca-899d-f311-aa9c-b5ccd1b29bd3",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "ac47db6a-46a3-8eb4-94b0-72bc72c79216",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "6937ee62a5ad120169000097"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "commodo ex velit",
    "can_download_receipt": false,
    "amount_refunded": "ex et ut",
    "refunded": "quis pariatur sed minim tempor",
    "refunds": [
      {
        "id": "6d6e4985-5fef-dd41-2c90-ecc52ba98cab",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "1eed37f4-1401-01cc-0c64-7133de2ddedf",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1963-01-14T13:55:52.0Z",
        "updated_at": "1947-12-31T03:43:14.0Z"
      },
      {
        "id": "bf405690-4aa4-da0d-f5ed-8c74bc40df3f",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "648170ec-8c67-2527-1c18-62b67c6f07d9",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1923-01-25T01:15:38.0Z",
        "updated_at": "1932-03-02T15:01:20.0Z"
      },
      {
        "id": "6835a0fd-538c-f91c-f525-9c31278e64a7",
        "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": "1925-02-07T19:02:29.0Z",
        "updated_at": "1932-01-24T08:51:22.0Z"
      },
      {
        "id": "1a3a1be3-d511-1bb0-3268-d8b667758c08",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "9cf7f3e4-c9ac-6838-37e2-cc78910e393c",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1892-01-09T21:52:01.0Z",
        "updated_at": "1900-04-05T22:19:18.0Z"
      }
    ],
    "site_id": "6bb8df0e-86e9-dd69-5c6f-56aee2b7c03b",
    "billing_period_from": "1964-10-07",
    "billing_period_to": "1957-03-02",
    "processing_at": "1909-07-10T15:21:59.0Z",
    "created_at": "1927-10-04T13:16:39.0Z",
    "updated_at": "1962-04-18T22:01: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": "aebf7bf0-82d7-efa6-87f2-aa732f42d551",
    "membership": {
      "id": "5c532828-3743-7d46-319f-e73bb368078c",
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_id": "151f90da-47e5-cd9e-01fa-d028a583c208",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "last_4": 4001,
      "processor_type": "Cash",
      "processor_type_id": "6937ee62a5ad120169000098"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "tax": 1000,
    "status": "succeeded",
    "description": "cupidatat amet nostrud enim",
    "can_download_receipt": true,
    "amount_refunded": "officia",
    "refunded": "voluptate est laborum",
    "refunds": [
      {
        "id": "cd5034de-a743-fd3a-75d1-0b57bdcc72cf",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "d1495051-7342-9c6d-0ff1-e616a38cd7b6",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1926-08-06T11:40:55.0Z",
        "updated_at": "1937-12-03T06:12:02.0Z"
      },
      {
        "id": "da1fd40c-a3a8-2da2-1ec6-82c9d2ef8d20",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "0a4261a9-c97b-f088-f2e7-fd679d5678a2",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1899-08-25T10:11:36.0Z",
        "updated_at": "1958-02-05T05:52:01.0Z"
      },
      {
        "id": "dda5a9ff-f780-417e-2ea1-a22a392114c2",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "e14ec613-acb3-ac95-5487-f3fab8220438",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1891-11-12T12:23:16.0Z",
        "updated_at": "1899-08-25T23:49:24.0Z"
      },
      {
        "id": "90758f0f-cd42-95d4-1cee-b9979f4cee6e",
        "status": "succeeded",
        "amount": 995,
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "id": "b0b7c20e-9b7f-699b-7b03-3624bb535f5d",
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        },
        "created_at": "1896-02-21T06:57:09.0Z",
        "updated_at": "1937-10-22T05:33:53.0Z"
      }
    ],
    "site_id": "5b2377dd-fd07-9bb0-c140-8c03c485c2a3",
    "billing_period_from": "1898-09-26",
    "billing_period_to": "1957-04-09",
    "processing_at": "1934-10-17T18:40:17.0Z",
    "created_at": "1939-05-09T06:01:42.0Z",
    "updated_at": "1962-09-29T18:17:57.0Z"
  }
}
404
example response
{
  "message": "The requested resource could not be found"
}