OrderDiscountUse2

Reports how much one coupon code applied to an order and how much of that discount has been refunded.

Most API integrations should omit this type. Use it only when the commerce platform can attribute discount amounts and refunds to an exact coupon code.

Amounts are cumulative order state, not incremental refund events.

Kind	Type
Used in	Cart2, EstimateAccrual1, LoadCart1, UpdateOrders4

Properties

• code string required

  Exact coupon code used on the order

• amount_applied monetary required

  Actual amount this code applied to the original order

  Report the amount the commerce platform accepted, which can be lower than the coupon's nominal value.

• amount_refunded monetary required

  Cumulative amount of this code removed by refunds

  Use zero when refunds have not removed any amount attributed to this code. Never exceed amount_applied.