Discount codes

Returns list of discounts in the shop.

Field	Description

Field	Description
Applies on subscription	Whether the discount applies on subscription shipping lines.
Applies once per customer	Whether the discount can be applied only once per customer.
Applies once per time purchase	Whether the discount applies on regular one-time-purchase shipping lines.
Async usage count	The number of times that the discount has been used.
Code count	The number of redeem codes for the discount.
Created at	The date and time when the discount was created.
Discount Id	The ID for the discount.
Discount class	The class of the discount for combining purposes.
Codes count	The number of redeem codes for the discount.
Codes count precision	Precision of codes count, how exact is the value.
Ends at	The date and time when the discount ends. For open-ended discounts, use `null`.
Has timeline comment	Indicates whether there are any timeline comments on the discount.
Recurring cycle limit	The number of times a discount applies on recurring purchases (subscriptions)
ShortSummary	A short summary of the discount.
Starts At	The date and time when the discount starts.
Status	The status of the discount.
Summary	A detailed summary of the discount.
Title	The title of the discount.
Updated at	The date and time when the discount was updated.
Usage limit	The maximum number of times that the discount can be used.

Determines which discount classes the discount can combine with.

Field	Description

Field	Description
Order discounts	Combines with order discounts.
Product discounts	Combines with product discounts.
Shipping discounts	Combines with shipping discounts.

A list of redeem codes for the discount.

Field	Description

Field	Description
Async usage count	The number of times that the discount redeem code has been used. This value is updated asynchronously and can be different than the actual usage count.
Code	The code that a customer can use at checkout to receive a discount.
Id	A globally-unique ID of the discount redeem code.

A shareable URL for a discount code.

Field	Description

Field	Description
Target type	The type of page that's associated with the URL.
Title	The title of the page that's associated with the URL.
Url	The URL for the discount code.

The total amount spent by this company, across all its locations.

Field	Description

Field	Description
Amount	Decimal money amount.
Currency code	Currency of the money.