Create coupon

post

https://{api_url}/api/v5/admin/{company_id}/coupons

Creates a new coupon.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

int32

required

Body Params

code

string

required

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

coupon_type

string

enum

required

Coupon type for coupon

Allowed:

company_scope

string

enum

Defines how coupon applies across companies.

Allowed:

service_scope

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

max_uses

int32

Maximum total uses (must be > 0)

max_per_person

int32

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

title

string

Coupon title

valid_from

date-time

Valid from date (must be >= current date)

valid_to

date-time

Valid to date (must be >= valid_from)

use_from

date-time

Use from date (must be >= current date)

use_to

date-time

Use to date (must be >= use from)

description

string

Coupon description

price

float

Fixed price or discount amount (must be > 0)

buy

int32

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

free

int32

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

percentage

int32

Percentage discount (1-100)

disabled

boolean

Responses

400

Validation Error

201Created