Sign in
Memberships

Update a Membership

Update mutable fields on an existing Membership such as its membership type, rate, start/end dates and external reference.

put/customers/memberships/{membershipId}

Request body

membership_type_idstring

The membership type ID. This must belong to the same brand as the given customer.

membership_rate_idstring

The membership rate ID. This must belong to the same type as provided.

start_datestring date

The date which the membership should start from.

end_datestring date nullable

The date which the membership should end.

external_refstring

Free-form identifier for cross-referencing this membership with an external system (e.g. a legacy CRM record number). Returned verbatim on getMembership and not interpreted by the platform.

Example request

{
  "membership_type_id": "000000-000000-000000-000000",
  "membership_rate_id": "000000-000000-000000-000000",
  "start_date": "2021-01-01",
  "end_date": "2022-01-01",
  "external_ref": "legacy-crm-7421"
}

Response

The Membership was successfully retrieved

Example response

{
  "data": {
    "customer": {
      "first_name": "Jane",
      "last_name": "Doe",
      "full_name": "Jane Doe",
      "phone": "+447900000000",
      "has_password": true,
      "stripe_id": "cus_1234567890",
      "express_stripe_id": "cus_1234567890",
      "email": "janedoe@example.com",
      "labels": [
        {
          "value": "VIP",
          "colour": "ff6634"
        }
      ],
      "preferred_locale": "en",
      "last_check_in": {
        "method": "Scanned"
      },
      "avatar_id": "000000-000000-000000-000000",
      "avatar": {
        "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": "ext-cust-789012"
    },
    "members": [
      {
        "membership_number": "1234567890"
      }
    ],
    "membership_number": "1234567890",
    "next_charge": {
      "amount": 3995,
      "currency": "GBP"
    },
    "payment_method": {
      "status": "revoked",
      "card_brand": "amex"
    },
    "rate": {
      "name": "Standard rate",
      "currency": "GBP",
      "price": 5000,
      "joining_fee": 1000,
      "billing_frequency": "P1M",
      "default_duration": "P1Y",
      "notice_period": "P1M",
      "private": true
    },
    "type": {
      "name": "Gold tier",
      "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
      "min_members": 2,
      "max_members": 4,
      "rates": [
        {
          "name": "Standard rate",
          "currency": "GBP",
          "price": 5000,
          "joining_fee": 1000,
          "billing_frequency": "P1M",
          "default_duration": "P1Y",
          "notice_period": "P1M",
          "private": true
        }
      ],
      "revenue_schedule": "FREQ=WEEKLY"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.