Returns a list of Coupons. Default sorting is by coupon/discount id, from lowest to highest. Optional filter parameters can be passed in.
The coupon’s ID. This is a read-only field; do not set or modify its value in a POST or PUT request.
The name of the coupon.
The discount to apply to an order, as either an amount or a percentage. This field’s usage is determined by the coupon
type. For example, a
type of +
percentage_discount would determine a percentage here.
Specifies a minimum value that an order must have before the coupon can be applied to it.
Specifies when a coupon expires. Coupons need not have an expiry date – you can also control expiry via +
max_uses_per_customer. If you do use this date field, the value must be in RFC 2822 format.
If the coupon is enabled, this field’s value is
The coupon code that customers will use to receive their discounts. Value must be unique.
If it is not included in the PUT request, its existing value on the coupon will be cleared. Also required to be set on the POST request
Number of times this coupon has been used. This is a read-only field; do not set or modify its value in a POST or PUT request.
Maximum number of times this coupon can be used.
Maximum number of times each customer can use this coupon.
This is a list of shipping-method names. A shipping method must be enabled on the store to use it with a coupon. To check which shipping methods are enabled, please use the List Shipping Methods endpoint.