Membership-types API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
GET /api/v1/membership-types
List Membership Types
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
include_inactive | query | No | boolean | |
page | query | No | integer | |
page_size | query | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/membership-types
Create Membership Type
Request body
| Field | Required | Type | Description |
|---|---|---|---|
name | Yes | string | |
description | No | string | |
type | Yes | string | |
price | Yes | number | |
currency | No | string | |
billing_interval | No | string | |
credits_included | No | integer | |
credits_per_interval | No | integer | |
unlimited | No | boolean | |
validity_days | No | integer | |
can_pause | No | boolean | |
max_pause_days | No | integer | |
sellable_online | No | boolean | |
rollover_enabled | No | boolean | |
max_rollover_credits | No | integer | |
late_cancel_fee_override | No | number | |
no_show_fee_override | No | number | |
is_intro_offer | No | boolean | |
intro_price | No | number | |
intro_validity_days | No | integer |
Responses
- 201 — Successful Response
- 422 — Validation Error
GET /api/v1/membership-types/{membership_type_id}
Get Membership Type
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_type_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
PUT /api/v1/membership-types/{membership_type_id}
Update Membership Type
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_type_id | path | Yes | integer |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
name | No | string | |
description | No | string | |
price | No | number | |
late_cancel_fee_override | No | number | |
no_show_fee_override | No | number | |
credits_included | No | integer | |
credits_per_interval | No | integer | |
unlimited | No | boolean | |
validity_days | No | integer | |
can_pause | No | boolean | |
max_pause_days | No | integer | |
is_active | No | boolean | |
sellable_online | No | boolean | |
rollover_enabled | No | boolean | |
max_rollover_credits | No | integer | |
is_intro_offer | No | boolean | |
intro_price | No | number | |
intro_validity_days | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/membership-types/{membership_type_id}
Deactivate Membership Type
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_type_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
PATCH /api/v1/membership-types/{membership_type_id}/reactivate
Reactivate Membership Type
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_type_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/membership-types/{membership_type_id}/remove
Remove Membership Type
Hard-delete a membership type. Blocked if any memberships reference it.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_type_id | path | Yes | integer |
Responses
- 204 — Successful Response
- 422 — Validation Error