Create coupon

Creates a new coupon.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Body Params
string
required

Coupon code (must be unique within company, 4–25 chars, alphanumeric only)

string
enum
required

Coupon type for coupon

Allowed:
string
enum

Defines how coupon applies across companies.

Allowed:
string
enum

Defines how coupon applies across services.

Allowed:
service_ids
array of int32s

Array of service IDs

service_ids
company_ids_to_include
array of int32s

List of company IDs where the coupon can be used (only if company_scope is "specific").

company_ids_to_include
company_ids_to_exclude
array of int32s

List of company IDs where the coupon cannot be used (only if company_scope is "specific").

company_ids_to_exclude
int32

Maximum total uses (must be > 0)

int32

Maximum uses per person (must be > 0 and <= max_uses)

string

Coupon title

date-time

Valid from date (must be >= current date)

date-time

Valid to date (must be >= valid_from)

date-time

Use from date (must be >= current date)

date-time

Use to date (must be >= use from)

string

Coupon description

float

Fixed price or discount amount (must be > 0)

int32

Number of items the customer needs to buy for the offer to apply (must be greater than 0)

int32

Number of items the customer gets for free as part of the offer (must be greater than 0)

int32

Percentage discount (1-100)

boolean
Responses

400

Validation Error

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