On this page
No Headings
The detailed information for a recurring invoice series, including payment terms and other configuration settings.
objectreferencestring^[\S\s]*$The reference data. Includes a Purchase Order (PO) number.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
notestring^[\S\s]*$A note to the invoice recipient. Also appears on the invoice notification email.
terms_and_conditionsstring^[\S\s]*$The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.
memostring^[\S\s]*$A private bookkeeping memo for the user.
attachmentsarrayAn array of PayPal IDs for the files that are attached to an invoice.
itemsobjectThe file reference. Can be a file in PayPal MediaServ, PayPal DMS, or another custom store.
idstring^.*$The ID of the referenced file.
reference_urlstringuriThe reference URL for the file.
content_typestring^.*$create_timeobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date and time when the file was created, in Internet date and time format.
sizestring^[0-9]+$The size of the file, in bytes.
payment_termobjectThe payment term of the invoice. Payment can be due upon receipt, a specified date, or in a set number of days.
The payment terms that define when payment is due for invoices in this series.
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 payment term. Payment can be due upon receipt, a specified date, or in a set number of days.
conditional_rulesobjectThe conditional rules associated with the payment term of the invoice. Includes early payment discount, late payment surcharge, and auto cancellation details.
early_payment_discountobjectThe early payment discount for the invoice. If the payer pays before the discount end date, the specified discount is applied.
discount_end_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The end date for the early payment discount, in Internet date and time format. For example, yyyy-MM-ddTz.
percentobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The early payment discount percentage value.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The early payment discount amount value.
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.is_appliedbooleanIndicates whether the particular rule is applied or not.
auto_cancellationobjectThe auto cancellation details for the invoice. If the payer does not pay by the specified date, the invoice is automatically cancelled.
cancel_by_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The date by which the invoice is automatically cancelled if unpaid, in Internet date and time format. For example, yyyy-MM-ddTz.
is_appliedbooleanIndicates whether the particular rule is applied or not.