Order Discounts

The order_discount object

A discount code that can be applied to a sales order.

An order discount reduces the order total by either a percentage or a fixed amount, depending on discount_type. The reduction is capped at the order total and rounded to the nearest cent.

idstring

Order discount ID.

objectstringenumValues:order_discount

Resource type identifier.

namestring

Display name of the discount.

codestring

The code a buyer enters to apply this discount to an order.

Codes are unique within your account and are matched without regard to letter case.

percentagestring (decimal)

The fraction of the order total taken off, as a decimal string.

This is a multiplier, not a whole percent: 0.1 takes 10% off. Only read when discount_type is percentage.

amountstring (decimal)

The flat amount taken off the order total, as a decimal string.

Only read when discount_type is amount.

discount_typestringenumValues:percentageamount

How the discount is calculated.

  • percentage: the order total is reduced by the fraction in percentage.
  • amount: the order total is reduced by the flat amount in amount.
order_countinteger

How many sales orders this discount has been applied to, across all buyers.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate Order DiscountOrder DiscountsPATCHUpdate Order DiscountOrder DiscountsGETList Order DiscountsOrder DiscountsGETRetrieve Order DiscountOrder DiscountsDELETEDelete Order DiscountOrder DiscountsPOSTFind Order Discount by CodeOrder DiscountsPOSTCreate Sales OrderSales OrdersPATCHUpdate Sales OrderSales OrdersGETList Sales OrdersSales OrdersGETRetrieve Sales OrderSales OrdersPUTClose Sales OrderSales OrdersPUTIssue Sales OrderSales OrdersPUTReopen Sales OrderSales OrdersPUTUnissue Sales OrderSales Orders