Update a plan. Existing members keep the terms they accepted

patch/api/v1/membership-plans/{id}

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/membership-plans/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

idstring required

Request body

namestring
descriptionstring
billing_interval'month' | 'year'
price_minorinteger

VAT-inclusive price per period in minor units

currencystring
tax_rate_bpsinteger
signup_fee_minorinteger
included_sessionsinteger
session_scope'services' | 'category' | 'any'
session_service_idsstring[]
session_categorystring
rollover_capinteger
service_discount_bpsinteger

Basis points off treatments (1500 = 15%)

product_discount_bpsinteger
priority_daysinteger

Extra days members can book ahead

min_term_periodsinteger
cancel_notice_daysinteger
allow_immediate_cancelboolean
max_pausesinteger

Pauses allowed per 12 months

max_pause_daysinteger
termsstring
onlineboolean
activeboolean
sortinteger
expected_versioninteger

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.