Skip to main content
POST
Create a coupon

Request Body

Example Request

Response

Errors

Errors use the standard envelope — see Errors.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Body

application/json
code
string
required
discount_type
enum<string>
required
Available options:
percent,
amount
discount_value
integer<int64>
required

Percentage (0-100) when discount_type is percent, otherwise amount in the lowest currency unit.

duration
enum<string>
required
Available options:
forever,
once,
repeating
duration_months
integer

Required when duration is repeating.

Response

Coupon created.

id
string<uuid>
tenant_id
string<uuid>
code
string
discount_type
enum<string>
Available options:
percent,
amount
discount_value
integer<int64>
duration
enum<string>
Available options:
forever,
once,
repeating
duration_months
integer | null
created_at
string<date-time>
updated_at
string<date-time>