configuration

The invoice configuration details. Includes partial payment, tip, and tax calculated after discount.

tax_calculated_after_discountbooleanOptional

Indicates whether the tax is calculated before or after a discount. If `false`, the tax is calculated before a discount. If `true`, the tax is calculated after a discount.

Defaulttrue

tax_inclusivebooleanOptional

Indicates whether the unit price includes tax.

Defaultfalse

allow_tipbooleanOptional

Indicates whether the invoice enables the customer to enter a tip amount during payment. If `true`, the invoice shows a tip amount field so that the customer can enter a tip amount. If `false`, the invoice does not show a tip amount field.

Note: This feature is not available for users in `Hong Kong`, `Taiwan`, `India`, or `Japan`.

Defaultfalse

partial_paymentobject<partial_payment>Optional

The partial payment details. Includes the minimum amount that the invoicer expects from the payer.

partial_payment properties

2 properties

allow_partial_paymentbooleanOptional

Indicates whether the invoice allows a partial payment. If `false`, the invoice must be paid in full. If `true`, the invoice allows partial payments.

Note: This feature is not available for users in `India`, `Brazil`, or `Israel`.

Defaultfalse

minimum_amount_dueobject<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

template_idstringOptional

The template ID. The template determines the layout of the invoice.

You can either use an existing template ID or create a new template via the create template API and then use the newly created template's ID.

Default"PayPal system template"Match^(TEMP-)[A-Z0-9]+$Length22 <= length <= 22

The invoice configuration details. Includes partial payment, tip, and tax calculated after discount.

tax_calculated_after_discountbooleanOptional

Indicates whether the tax is calculated before or after a discount. If `false`, the tax is calculated before a discount. If `true`, the tax is calculated after a discount.

Defaulttrue

tax_inclusivebooleanOptional

Indicates whether the unit price includes tax.

Defaultfalse

allow_tipbooleanOptional

Note: This feature is not available for users in `Hong Kong`, `Taiwan`, `India`, or `Japan`.

Defaultfalse

partial_paymentobject<partial_payment>Optional

The partial payment details. Includes the minimum amount that the invoicer expects from the payer.

partial_payment properties

2 properties

allow_partial_paymentbooleanOptional

Indicates whether the invoice allows a partial payment. If `false`, the invoice must be paid in full. If `true`, the invoice allows partial payments.

Note: This feature is not available for users in `India`, `Brazil`, or `Israel`.

Defaultfalse

minimum_amount_dueobject<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

template_idstringOptional

The template ID. The template determines the layout of the invoice.

You can either use an existing template ID or create a new template via the create template API and then use the newly created template's ID.

Default"PayPal system template"Match^(TEMP-)[A-Z0-9]+$Length22 <= length <= 22

configuration

partial_payment properties

money properties

Back to top

On this page

On this page

configuration

partial_payment properties

money properties

Back to top

On this page

configuration

partial_payment properties

money properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

configuration

partial_payment properties

money properties

Back to top

On this page