A discount can be applied to a cart for promotional purposes.
The discount's ID
The date with timezone at which the resource was created.
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
A unique code for the discount - this will be used by the customer to apply the discount
A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts
The ID of the discount rule that defines how the discount will be applied to a cart.
ruleDiscountRuleRequiredThe details of the discount rule that defines how the discount will be applied to a cart..
Whether the Discount has been disabled. Disabled discounts cannot be applied to carts
The Discount that the discount was created from. This will always be a dynamic discount
parent_discountDiscountRequiredThe details of the parent discount that this discount was created from.
The time at which the discount can be used.
ends_atnull | DateRequired
The time at which the discount can no longer be used.
valid_durationnull | stringRequired
Duration the discount runs between
regionsRegionRequiredThe details of the regions in which the Discount can be used.
usage_limitnull | numberRequired
The maximum number of times that a discount can be used.
The number of times a discount has been used.
An optional key-value map with additional details
Was this section helpful?