On this page
No Headings
The details for each template. If fields is none, returns only the template name, ID, and default status.
arrayitemsobjectThe invoicing template.
template_idstringThe ID of the template.
namestringThe template name.
Note: The template name must be unique.
defaultbooleanIndicates whether this template is the default merchant template. A merchant can have one default template.
template_dataobjectThe template data.
merchant_inforequiredobjectThe merchant business information that appears on the invoice.
emailstringemailThe merchant email address. This email must be listed in the merchant's PayPal profile.
If you omit this value, notifications are sent from and to the primary email address but do not appear on the invoice.
business_namestringThe merchant's business name.
first_namestringThe merchant's first name.
last_namestringThe merchant's last name.
addressobjectThe merchant's address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
country_coderequiredstringThe two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas is used in that country's top-level domain names. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
statestringphonestringphoneThe phone number, in its canonical international E.164 numbering plan format.
phoneobjectThe merchant's phone number.
country_codestring^[0-9]{1,3}?$The country code portion of the phone number, in E.164 format.
national_numberstring^[0-9]{1,14}?$The in-country phone number, in E.164 format.
faxobjectThe merchant's fax number.
country_codestring^[0-9]{1,3}?$The country code portion of the phone number, in E.164 format.
national_numberstring^[0-9]{1,14}?$The in-country phone number, in E.164 format.
websitestringuriThe merchant's website.
tax_idstringThe merchant's tax ID.
additional_infostringAny additional information, such as business hours.
billing_infoarrayThe billing information of the invoice recipient.
Note: This value is an array with only one element.
itemsobjectThe billing information for the invoice recipient.
emailstringemailThe invoice recipient email address. If you omit this value, the invoice is payable and a notification email is not sent.
phoneobjectThe invoice recipient's phone number.
country_codestring^[0-9]{1,3}?$The country code portion of the phone number, in E.164 format.
national_numberstring^[0-9]{1,14}?$The in-country phone number, in E.164 format.
first_namestringThe invoice recipient's first name.
last_namestringThe invoice recipient's last name.
business_namestringThe invoice recipient's business name.
addressobjectThe invoice recipient's billing address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
country_coderequiredstringThe two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas is used in that country's top-level domain names. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
statestringphonestringphoneThe phone number, in its canonical international E.164 numbering plan format.
languagestring"da_DK", "de_DE", "en_AU", "en_GB", "en_US", "es_ES", "es_XC", "fr_CA", "fr_FR", "fr_XC", "he_IL", "id_ID", "it_IT", "ja_JP", "nl_NL", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ru_RU", "sv_SE", "th_TH", "tr_TR", "zh_CN", "zh_HK", "zh_TW", "zh_XC"The language in which the invoice recipient's email appears. Used only when the recipient does not have a PayPal account.
If you omit the language and the recipient does not have a PayPal account, the email is sent in the language of the merchant's PayPal account.
additional_infostringAny additional information about the recipient.
shipping_infoobjectThe shipping information for the invoice recipient.
first_namestringThe first name of the recipient at the shipping address.
last_namestringThe last name of the recipient at the shipping address.
business_namestringThe business name of the recipient at the shipping address.
addressobjectThe shipping address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
country_coderequiredstringThe two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas is used in that country's top-level domain names. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
statestringphonestringphoneThe phone number, in its canonical international E.164 numbering plan format.
cc_infoarrayAn array of email addresses to which PayPal sends a copy of the invoice.
itemsstringemailThe participant's email address.
itemsarrayAn array of invoice line item information. The maximum items for an invoice is 100.
itemsobjectThe invoice line item information.
namerequiredstringThe item name.
descriptionstringThe item description.
quantityrequirednumberThe item quantity. Value is from -10000 to 10000. Supports up to five decimal places.
unit_pricerequiredobjectThe currency and amount of the item unit price. Value is from -1000000 to 1000000. Supports up to two decimal places.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax information.
namerequiredstringThe tax name.
percentrequirednumberThe tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount of the calculated tax.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
datestringdateThe date when the item or service was provided, in Internet date and time format. For example, yyyy-MM-dd z.
discountobjectThe item discount, as a percent or an amount value.
percentnumberThe discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount of the invoice-level discount. Value is from 0 to 1000000. Supports up to two decimal places.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.unit_of_measurestring"QUANTITY", "HOURS", "AMOUNT"The unit of measure for the invoiced item. For AMOUNT the unit_price and quantity are not shown on the invoice.
Note: If your specify different unit_of_measure values for the same invoice, the invoice uses the first value.payment_termobjectThe payment term of the invoice. If you specify term_type, you cannot specify due_date, and vice versa.
term_typestring"DUE_ON_RECEIPT", "DUE_ON_DATE_SPECIFIED", "NET_10", "NET_15", "NET_30", "NET_45", "NET_60", "NET_90", "NO_DUE_DATE"The term when the invoice payment is due.
due_datestringdateThe date when the invoice payment is due, in Internet date and time format. For example, yyyy-MM-dd z.
referencestringThe reference data, such as a PO number.
discountobjectThe invoice level discount, as a percent or an amount value.
percentnumberThe discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount of the invoice-level discount. Value is from 0 to 1000000. Supports up to two decimal places.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_costobjectThe shipping cost, as a percent or an amount value.
amountobjectThe currency and amount of the shipping charge. Value is from 0 to 1000000. Supports up to two decimal places.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax percentage on the shipping amount.
namerequiredstringThe tax name.
percentrequirednumberThe tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount of the calculated tax.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
customobjectThe custom amount to apply to an invoice. If you include a label, you must include a custom amount.
labelstringThe custom amount label.
amountobjectThe currency and amount of the custom value. Value is from -1000000 to 1000000. Supports up to two decimal places.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.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 merchants inIndia,Brazil, orIsrael.
minimum_amount_dueobjectThe currency and amount of the minimum allowed for a partial payment. Valid only when allow_partial_payment is true.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_calculated_after_discountbooleanfalseIndicates 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.
termsstringThe general terms of the invoice.
notestringA note to the invoice recipient. This note also appears on the invoice notification email.
merchant_memostringA private bookkeeping memo for the merchant.
logo_urlstringuriThe full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.
total_amountobjectThe currency and amount of the invoice total.
valuerequiredstringThe value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.attachmentsarrayAn array of PayPal file IDs for the files that are attached to an invoice. The maximum number of files is 5.
itemsobjectThe file that is attached to an invoice or template.
namestringThe name of the attached file.
urlstringuriThe URL of the attached file. Use this URL to download the file.
settingsarrayAn array of template settings that describe which fields to show or hide when creating an invoice.
itemsobjectThe template settings.
field_namestring"items.quantity", "items.description", "items.date", "items.discount", "items.tax", "discount", "shipping", "custom"The field name in template_data for which to map corresponding display preferences.
display_preferenceobjectThe template settings metadata.
hiddenbooleanfalseIndicates whether to show or hide this field.
unit_of_measurestring"HOURS", "QUANTITY", "AMOUNT"The unit of measure for the template.
custombooleanIndicates whether this template is a merchant-created custom template. The system generates non-custom templates.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^[\S\s]*$The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstring^[\S\s]*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH"The HTTP method required to make the related call.
titlestring^[\S\s]*$The link title.
mediaTypestring^[\S\s]*$The media type, as defined by RFC 2046. Describes the link target.
encTypestring^[\S\s]*$"application/json"The media type in which to submit the request data.
schemaobjectThe schema that describes the request data.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.
targetSchemaobjectThe schema that describes the link target.
additionalItemsobjectAny additional items.
dependenciesobjectAny Dependencies.
itemsobjectAn item.
patternPropertiesobjectThe pattern properties.
propertiesobjectProperties.
allOfarrayAn array of sub-schemas. The data must validate against all sub-schemas.
itemsobjectA sub-schema against which the data must validate.
anyOfarrayAn array of sub-schemas. The data must validate against one or more sub-schemas.
itemsobjectA sub-schema against which the data must validate.
oneOfarrayAn array of sub-schemas. The data must validate against one sub-schema.
itemsobjectA sub-schema against which the data must validate.
notobjectNot.
linksarrayAn array of links.
itemsobjectA link.
fragmentResolutionstring^[\S\s]*$The fragment resolution.
mediaobjectThe media type and context-encoding scheme.
typestring^[\S\s]*$The media type. See Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types.
binaryEncodingstring^[\S\s]*$The content-encoding scheme. See Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
pathStartstringuriTo apply this schema to the instances' URIs, start the URIs with this value.