Skip to main content
Skip to main content

AdminPostDiscountsDiscountReq

The details of the discount to update.

Properties

codestring
A unique code that will be used to redeem the discount
The discount rule that defines how discounts are calculated
is_disabledboolean
Whether the discount code is disabled on creation. If set to true, it will not be available for customers.
starts_atDate
The date and time at which the discount should be available.
ends_atnull | Date
The date and time at which the discount should no longer be available.
valid_durationnull | string
The duration the discount runs between
usage_limitnull | number
Maximum number of times the discount can be used
regionsstring[]
A list of region IDs representing the Regions in which the Discount can be used.
metadataRecord<string, unknown>
An object containing metadata of the discount
Was this section helpful?