Aller au contenu principal

Membership-types API

Auto-generated from the OpenAPI spec. Run node docs-site/scripts/fetch-openapi.js to regenerate.

GET /api/v1/membership-types​

List Membership Types

Parameters

NameInRequiredTypeDescription
include_inactivequeryNoboolean
removedqueryNoboolean
searchqueryNo
pagequeryNointeger
page_sizequeryNointeger

Responses

  • 200 — Successful Response
  • 422 — Validation Error

POST /api/v1/membership-types​

Create Membership Type

Request body

FieldRequiredTypeDescription
nameYesstring
descriptionNostring
typeYesstring
priceYesnumber
currencyNostring
billing_intervalNostring
credits_includedNointeger
credits_per_intervalNointeger
unlimitedNoboolean
validity_daysNointeger
can_pauseNoboolean
max_pause_daysNointeger
sellable_onlineNoboolean
rollover_enabledNoboolean
max_rollover_creditsNointeger
late_cancel_fee_overrideNonumber
no_show_fee_overrideNonumber
is_intro_offerNoboolean
intro_priceNonumber
intro_validity_daysNointeger
usable_forNostring
class_template_idsNoarray
required_tag_idsNoarray
excluded_tag_idsNoarray

Responses

  • 201 — Successful Response
  • 422 — Validation Error

currency accepts only EUR, GBP, CHF, USD, SEK, NOK, DKK, PLN, CZK and RON, and defaults to EUR. Any other value is rejected with 422.

The list is restricted to currencies whose minor unit is 1/100, because amounts are converted to minor units before reaching the payment provider. A zero-decimal currency would be charged 100 times over.


GET /api/v1/membership-types/{membership_type_id}​

Get Membership Type

Parameters

NameInRequiredTypeDescription
membership_type_idpathYesinteger

Responses

  • 200 — Successful Response
  • 422 — Validation Error

PUT /api/v1/membership-types/{membership_type_id}​

Update Membership Type

Parameters

NameInRequiredTypeDescription
membership_type_idpathYesinteger

Request body

FieldRequiredTypeDescription
nameNostring
descriptionNostring
priceNonumber
currencyNostring
late_cancel_fee_overrideNonumber
no_show_fee_overrideNonumber
credits_includedNointeger
credits_per_intervalNointeger
unlimitedNoboolean
validity_daysNointeger
can_pauseNoboolean
max_pause_daysNointeger
is_activeNoboolean
sellable_onlineNoboolean
rollover_enabledNoboolean
max_rollover_creditsNointeger
is_intro_offerNoboolean
intro_priceNonumber
intro_validity_daysNointeger
usable_forNostring
class_template_idsNoarray
required_tag_idsNoarray
excluded_tag_idsNoarray

Responses

  • 200 — Successful Response
  • 422 — Validation Error

currency accepts only EUR, GBP, CHF, USD, SEK, NOK, DKK, PLN, CZK and RON, and defaults to EUR. Any other value is rejected with 422.

The list is restricted to currencies whose minor unit is 1/100, because amounts are converted to minor units before reaching the payment provider. A zero-decimal currency would be charged 100 times over.

Omitting currency leaves the existing value unchanged.


DELETE /api/v1/membership-types/{membership_type_id}​

Deactivate Membership Type

Parameters

NameInRequiredTypeDescription
membership_type_idpathYesinteger

Responses

  • 200 — Successful Response
  • 422 — Validation Error

PATCH /api/v1/membership-types/{membership_type_id}/reactivate​

Reactivate Membership Type

Parameters

NameInRequiredTypeDescription
membership_type_idpathYesinteger

Responses

  • 200 — Successful Response
  • 422 — Validation Error

DELETE /api/v1/membership-types/{membership_type_id}/remove​

Remove Membership Type

Soft-delete a membership type. Blocked if any memberships reference it.

Removed types are hidden from the default/active list but remain in the DB (visible via GET .../membership-types?removed=true) and can be restored via PATCH .../restore.

Parameters

NameInRequiredTypeDescription
membership_type_idpathYesinteger

Responses

  • 204 — Successful Response
  • 422 — Validation Error

PATCH /api/v1/membership-types/{membership_type_id}/restore​

Restore Membership Type

Parameters

NameInRequiredTypeDescription
membership_type_idpathYesinteger

Responses

  • 200 — Successful Response
  • 422 — Validation Error