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 expects from the payer.
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 currency and amount for a financial transaction, such as a balance or payment due.
The minimum amount allowed for a partial payment. Valid only when allow_partial_payment is true.
currency_coderequiredstring^[\S\s]*$The 3-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.template_idstring^(TEMP-)[A-Z0-9]+$"PayPal system template"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.