Discount Object Fields
Read about the fields that are used to model discounts.
You can specify discounts at the transaction or transaction-line level.
Restrictions
- You only need to use one of the
discount.discount_amountordiscount.discount_total_amountfields, matching the logic you use for amounts generally, that is whether you use tax inclusive or tax exclusive prices. The service will calculate the amounts for both options and return these in the response. - If the discount is specified at the Transaction level, it is duplicated to each line in the transaction.
Fields
The following table lists the fields that you can use to specify a discount in your requests.
| Field | Details | Description |
|---|---|---|
discount_code | Type: String | Discount code. Used to track the relationship of transaction-level discounts and discounts to individual transaction lines. This value must be unique for the transaction, even if it is specified on the transaction line level. |
discount_description | Type: String Max: 256 | Description of the discount. |
discount_amount | Type: Number | The amount of the discount that is applied for tax exclusive prices. If your prices do not include tax, use this field. |
discount_total_amount | Type: Number | The amount of the discount that is applied for tax inclusive prices. If your prices do include tax, use this field. |
Updated about 1 month ago