Raw purchase subscription discount.
| name | data type | description |
|---|---|---|
| discountAmount | number | The discount amount. Mutually exclusive with discount percent. Deprecated in favor of discountAmountIncludingTax. Having both
values will cause the deprecated one to be overridden.
|
| discountPercent | number | The optional discount percent. Mutually exclusive with discount amount. Must be a value between zero and one, e.g. 0.05 = 5% discount. |
| sort | number | The discount sort represents the order in which the discounts will be applied. The discount with the lowest sort will be applied first. Lowest sort must be 1, sort must be unique per discount array and must be sequential. |
| numberOfUses | number | The number of uses represents how many times the discount can be used. If there are multiple rows with discounts in the same subscription, then the number of uses must be the same for identical sort. If the number of uses is zero, then the discount will be applied until the subscription is cancelled. |
| discountAmountIncludingTax | number | The discount amount including tax. Mutually exclusive with discount percent. |
| discountAmountExcludingTax | number | The discount amount excluding tax. Mutually exclusive with discount percent. |
Example
{
"discountAmount" : 12345.0,
"discountPercent" : 12345.0,
"sort" : 12345,
"numberOfUses" : 12345,
"discountAmountIncludingTax" : 12345.0,
"discountAmountExcludingTax" : 12345.0
}