Sign in
MembershipRates

Update a MembershipRate

Update an existing MembershipRate. Only fields included in the request body will be changed.

put/customers/membership-rates/{rateId}

Request body

namestring

Operator-facing label for the rate. Shown alongside the membership type when staff issue or amend memberships. Common values include Standard rate, Concession and Founder.

priceinteger

The price of the rate as an integer of the smallest unit (eg pence).

currencystring

The currency of the price, uppercase, in the ISO4217 format

joining_feeinteger

The price of the joining fee as an integer of the smallest unit (eg pence).

privateboolean

Whether this rate is private

billing_frequencystring

The frequency that this membership is billed. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations

default_durationstring

The default duration of the membership. This is used when a customer signs themselves up for a membership. The duration is specified as an ISO8601 duration string.

notice_period'P7D' | 'P14D' | 'P1M' | 'P3M' | 'P6M' | 'P1Y' | 'null' nullable

How much notice a customer must give to cancel a membership on this rate. The duration is specified as an ISO8601 duration string. See https://en.wikipedia.org/wiki/ISO_8601#Durations When null, no notice is required.

Example request

{
  "name": "Standard rate",
  "price": 5000,
  "currency": "GBP",
  "joining_fee": 1000,
  "private": true,
  "billing_frequency": "P1M",
  "default_duration": "P1Y",
  "notice_period": "P1M"
}

Response

The MembershipRate was successfully retrieved or updated.

Example response

{
  "data": {
    "name": "Standard rate",
    "currency": "GBP",
    "price": 5000,
    "joining_fee": 1000,
    "billing_frequency": "P1M",
    "default_duration": "P1Y",
    "notice_period": "P1M",
    "private": true
  }
}

Changes

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