Create Coupon

Overview

Creates a new coupon for the business. Available for Staff tokens.

Coupon Code

If the code field is left blank, a random alphanumeric code will be auto-generated. Coupon codes must be between 5 and 15 characters long and may only contain letters, numbers, and underscores.

Validation Rules

  • name is required and must be unique among active coupons.
  • coupon_type is required and must be either fixed or percent.
  • amount is required and must be a non-negative number.
  • starts_at is required. The date and time when the coupon becomes active.
  • expires_at is required. Must be a future date and must be at least 6 hours later than starts_at.
  • code must be unique among active coupons (if provided).
  • For percent type coupons, amount represents the percentage discount (e.g., 50 means 50% off).
  • For fixed type coupons, amount represents the fixed monetary discount in the business currency.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The display name of the coupon (e.g., "Summer Sale"). Must be unique among active coupons.

string
enum
required

The type of discount. Possible values: fixed (a fixed monetary amount off) or percent (a percentage off).

Allowed:
string

The coupon code that clients enter to redeem the discount (e.g., "SUMMER20"). Must be 5-15 characters, alphanumeric and underscores only. If omitted, a random code is auto-generated.

number
required

The discount value. For percent type, this is the percentage (e.g., 50 means 50% off). For fixed type, this is the monetary amount in the business currency.

date-time
required

The date and time when the coupon becomes active, in ISO 8601 format (e.g., "2026-02-07T22:00:00.000Z").

date-time
required

The date and time when the coupon expires, in ISO 8601 format (e.g., "2027-02-08T21:59:59.000Z"). Must be a future date and later than starts_at.

integer

The maximum total number of times this coupon can be redeemed across all clients. Set to null for unlimited redemptions.

integer

The maximum number of times a single client can redeem this coupon. Set to null for unlimited per-client redemptions.

valid_services
array of strings

An array of service UIDs that this coupon is valid for. Set to null to make the coupon valid for all services.

valid_services
valid_staff
array of strings

An array of staff UIDs whose services this coupon is valid for. Set to null to make the coupon valid for all staff members.

valid_staff
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json