Promo-codes API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
GET /api/v1/promo-codes
List Promo Codes
List all promo codes. Manager-only.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
active_only | query | No | boolean | |
page | query | No | integer | |
page_size | query | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/promo-codes
Create Promo Code
Create a new promo code. Manager-only.
Request body
| Field | Required | Type | Description |
|---|---|---|---|
code | Yes | string | |
discount_type | Yes | string | |
discount_value | Yes | number | |
applicable_membership_type_ids | No | array | |
max_uses | No | integer | |
one_per_client | No | boolean | |
valid_from | Yes | string | |
valid_until | No | string | |
is_active | No | boolean |
Responses
- 201 — Successful Response
- 422 — Validation Error
GET /api/v1/promo-codes/{promo_code_id}
Get Promo Code
Get a promo code by ID. Manager-only.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
promo_code_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
PUT /api/v1/promo-codes/{promo_code_id}
Update Promo Code
Update a promo code. Manager-only.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
promo_code_id | path | Yes | integer |
Request body
| Field | Required | Type | Description |
|---|---|---|---|
code | No | string | |
discount_type | No | string | |
discount_value | No | number | |
applicable_membership_type_ids | No | array | |
max_uses | No | integer | |
one_per_client | No | boolean | |
valid_from | No | string | |
valid_until | No | string | |
is_active | No | boolean |
Responses
- 200 — Successful Response
- 422 — Validation Error
DELETE /api/v1/promo-codes/{promo_code_id}
Deactivate Promo Code
Deactivate a promo code (set is_active=False). Manager-only.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
promo_code_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/promo-codes/validate
Validate Promo Code Endpoint
Validate a promo code and return discount info. Does NOT record usage.
Accessible by authenticated clients and managers.
Request body
| Field | Required | Type | Description |
|---|---|---|---|
code | Yes | string | |
membership_type_id | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error