Memberships API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
GET /api/v1/memberships
List Memberships
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
client_id | query | No | integer | |
status | query | No | ||
page | query | No | integer | |
page_size | query | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/memberships
Assign Membership
Request body
| Field | Required | Type | Description |
|---|---|---|---|
client_id | Yes | integer | |
membership_type_id | Yes | integer | |
starts_at | Yes | string | |
expires_at | No | string | |
credits_remaining | No | integer | |
notes | No | string |
Responses
- 201 — Successful Response
- 422 — Validation Error
GET /api/v1/memberships/{membership_id}
Get Membership
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
PUT /api/v1/memberships/{membership_id}
Update Membership
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_id | path | Yes | integer |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
status | No | string | |
expires_at | No | string | |
credits_remaining | No | integer | |
notes | No | string |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/memberships/{membership_id}
Cancel Membership
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/memberships/{membership_id}/pause
Pause Membership
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_id | path | Yes | integer |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
pause_days | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/memberships/{membership_id}/resume
Resume Membership
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
membership_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error