AdminPostDiscountsReq
The details of the discount to create.
Properties
code
stringRequiredA unique code that will be used to redeem the discount
The discount rule that defines how discounts are calculated
is_dynamic
booleanRequiredWhether the discount should have multiple instances of itself, each with a different code. This can be useful for automatically generated discount codes that all have to follow a common set of rules.
Default: false
is_disabled
booleanRequiredWhether the discount code is disabled on creation. If set to
true
, it will not be available for customers.Default: false
regions
string[]RequiredA list of region IDs representing the Regions in which the Discount can be used.
starts_at
DateThe date and time at which the discount should be available.
ends_at
DateThe date and time at which the discount should no longer be available.
valid_duration
stringThe duration the discount runs between
usage_limit
numberMaximum number of times the discount can be used
metadata
Record<string, unknown>An optional set of key-value pairs to hold additional information.
Was this section helpful?