On this page
No Headings
The invoice configuration details. Includes partial payment, tip, and tax calculated after discount.
objecttax_calculated_after_discountbooleantrueIndicates 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.
tax_inclusivebooleanfalseIndicates whether the unit price includes tax.
allow_tipbooleanfalseIndicates 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 inHong Kong,Taiwan,India, orJapan.
partial_paymentobjectThe partial payment details. Includes the minimum amount that the invoicer wants the payer to pay.
allow_partial_paymentbooleanfalseIndicates 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 inIndia,Brazil, orIsrael.
minimum_amount_dueobjectThe minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.has_conditional_rulebooleanfalseIndicates whether conditional pricing rules are applied to the invoice. If true, pricing rules (such as discounts or surcharges based on specific conditions) are applied. If false, no conditional pricing rules are applied.
template_idstring"PayPal system template"The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.
Note: This is an optional field. If you wish to customize the invoice layout using a specific template, provide a valid template ID here. 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.