Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

discount

The discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.

percentstring<percentage>Optional

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

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](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

Back to top

discount

The discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.

percentstring<percentage>Optional

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

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](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

discount

money properties

Back to top

On this page

On this page

discount

money properties

Back to top

On this page

discount

money properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

discount

money properties

Back to top

On this page