Create Discount Code
POST/api/discount-codes
Create a new discount code.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Fields:
- code (required): Unique discount code string (max 255 chars)
- description (optional): Description of the discount (max 500 chars)
- type (required): Discount value type. One of: percentage, fixed_amount
- rate (optional): Percentage rate (0–100). Used when type is 'percentage'
- amount (optional): Fixed amount. Used when type is 'fixed_amount'
- scope (required): What the discount applies to. One of: line, order, both
- apply_before_tax (optional): Whether discount is applied before tax calculation
- is_active (optional): Whether the code is active
Requires permission: discount_codes.create
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.