Discount

The discount as a percent or an amount value. For example, to specify 10%, enter 10. Alternatively, to specify an amount of 5, enter 5.

percentnumberOptional

The discount as a percentage value. Value is from `0` to `100`. Supports up to five decimal places.

amountobject<currency>Optional

The currency and amount of the invoice-level discount. Value is from `0` to `1000000`. Supports up to two decimal places.

2 properties

currencystringRequired

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/).

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency codes - ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).

Back to top