On this page
No Headings
The invoice configuration details. Includes partial payment, tip, and tax calculated after discount.
objecttemplate_idstring^[\S\s]*$"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.
payment_method_overridesarrayThe payment method override configurations for the invoice. Defines which payment methods are enabled and any rules that control payment behavior. When provided during invoice creation or update, this array replaces any existing payment method override configuration for the invoice.
Note: Payment method availability depends on the merchant's country, the buyer's country, and the invoice amount. Override configurations only take effect if the specified payment method is available for the invoice.
itemsobjectThe details about a payment method override configured for the invoice via payment method overrides object.
payment_method_typestring"PAY_BY_BANK", "ACH"The payment method types that can be configured in the payment method overrides object for invoice payments.
Note: To usePAY_BY_BANK, you must first complete the onboarding process. Visit the onboarding page to get started. Once onboarding is complete, you can configurePAY_BY_BANKas a payment method.
enabledbooleanIndicates whether the specified payment method is enabled for the invoice. When set to true, the payment method is available for the buyer to use. When set to false, the payment method is disabled.
rulesarrayThe list of payment method override rules applied to the invoice via payment method overrides object. Each rule defines a specific restriction or behavior for the payment method, such as making it the exclusive payment option when the invoice total exceeds a system-defined threshold.
itemsobjectThe details about a payment method override rule applied to the invoice via payment method overrides object.
rule_typerequiredstring"EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD", "ALLOW_ONLY_ACH"The type of rule that can be applied to a payment method configured via payment method overrides object on an invoice. Each rule controls how a payment method behaves based on the invoice total.
System-defined threshold limits by payment method:
- PAY_BY_BANK - $1000
rule_valuerequiredstring^[a-zA-Z0-9\s,.]+$The value associated with the payment method override rule. For the EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD rule type, set this to true to enable the rule or false to disable it.
themeobjectThe theme configuration that defines the visual appearance of the invoice buyer experience and email. Pass an empty object to use the default theme.
primary_colorstring^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$The primary color chosen by the merchant for branding the invoice buyer experience and email. Accepts a hex color code in #RGB or #RRGGBB format.