Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Search recurring invoices series - response object.

An array of merchant recurring invoices series. It includes HATEOAS links for navigation.

recurring_invoicesobject<recurring_series>[]Optional

The list of recurring invoices series that match the search criteria.

Items1 <= length <= 100

recurring_series properties

6 properties

idstringOptional

The unique identifier for the recurring invoice series. This ID is used to reference and manage the series in all API operations.

Match^(RI-)[A-Z0-9]+$Length20 <= length <= 20

statusenum<recurring_status>Optional

The lifecycle status of a recurring invoice series. Determines the operational state and whether invoices are actively being generated.

Allowed values

"DRAFT"
"ACTIVE"
"CANCELLED"
"EXPIRED"

plan_detailobject<plan>Required

The scheduling and recurrence configuration that defines when and how often invoices are automatically generated and sent to customers in a recurring series.

plan properties

5 properties

total_cyclesintegerOptional

The total number of billing cycles (invoices) that will be generated in this recurring series. Once all cycles are completed, the series automatically expires. Note: if not set, then the series will be indefinite.

Range0 <= value <= 99

frequencyobject<plan_frequency>Required

The frequency of the recurring invoice series cycle.

plan_frequency properties

2 properties

interval_unitenumRequired

The time unit for the recurring invoice cycle interval. Used together with interval_count to determine the frequency of invoice generation.

Allowed values

"DAY"
"WEEK"
"MONTH"
"YEAR"

interval_countintegerRequired

The number of intervals between each recurring invoice cycle. For example, an interval_count of 2 with interval_unit of MONTH means the invoice recurs every 2 months.

Default1Range1 <= value <= 52

start_series_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). 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.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

next_occurrence_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). 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.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

completed_cyclesintegerOptional

The number of billing cycles (invoices) that have already been generated and sent in this recurring series. This counter increments with each invoice sent and helps track progress toward the total cycles.

Range0 <= value <= 2147483647

recurring_infoobject<recurring_info>Required

Comprehensive information about a recurring invoice series, including invoice details, participant information, line items, and amount calculations.

recurring_info properties

7 properties

detailobject<recurring_series_detail>Required

The detailed information for a recurring invoice series, including payment terms and other configuration settings.

recurring_series_detail properties

8 properties

referencestringOptional

The reference data. Includes a Purchase Order (PO) number.

Match^[\S\s]*$Length1 <= length <= 120

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

notestringOptional

A note to the invoice recipient. Also appears on the invoice notification email.

Match^[\S\s]*$Length1 <= length <= 4000

terms_and_conditionsstringOptional

The general terms of the invoice. Can include return or cancellation policy and other terms and conditions.

Match^[\S\s]*$Length1 <= length <= 4000

memostringOptional

A private bookkeeping memo for the user.

Match^[\S\s]*$Length1 <= length <= 500

attachmentsobject<file_reference>[]Optional

An array of PayPal IDs for the files that are attached to an invoice.

Items0 <= length <= 32767

file_reference properties

5 properties

idstringOptional

The ID of the referenced file.

Match^.*$Length1 <= length <= 255

reference_urlstringOptional

The reference URL for the file.

FormaturiLength1 <= length <= 2000

content_typestringOptional

The [Internet Assigned Numbers Authority (IANA) media type of the file](https://www.iana.org/assignments/media-types/media-types.xhtml).

Match^.*$Length0 <= length <= 255

create_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[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})$Length20 <= length <= 64

sizestringOptional

The size of the file, in bytes.

Match^[0-9]+$Length0 <= length <= 100

payment_termobject<recurring_payment_term>Optional

The payment term of the recurring invoice. Payment can be due upon receipt, in a set number of days, or have no due date. Also includes the conditional rules (early payment discount, auto cancellation) associated with the recurring invoice.

recurring_payment_term properties

2 properties

term_typeenum<payment_term_type>Optional

The payment term. Payment can be due upon receipt, a specified date, or in a set number of days.

Allowed values

"DUE_ON_RECEIPT"
"DUE_ON_DATE_SPECIFIED"
"NET_10"
"NET_15"
"NET_30"
"NET_45"
"NET_60"
"NET_90"
"NO_DUE_DATE"

conditional_rulesobject<recurring_payment_term_conditional_rules>Optional

The conditional rules associated with the recurring invoice. Includes early payment discount and auto cancellation details, expressed relative to each occurrence rather than as a single resolved date since a series has no fixed issue date or due date.

recurring_payment_term_conditional_rules properties

2 properties

early_payment_discountobject<recurring_early_payment_discount>Optional

The early payment discount for a recurring invoice. Since a series has no fixed issue date or due date, the discount window is expressed as a condition relative to each occurrence's issue date rather than a single resolved calendar date.

recurring_early_payment_discount properties

3 properties

conditionenum<conditional_rule_relative_conditions>Optional

Defines the time-based condition that triggers a conditional rule on a recurring invoice, expressed as a period relative to either the invoice issue date (for early payment discounts) or the invoice due date (for auto-cancellation).

Allowed values

"THREE_DAYS_AFTER_ISSUE_DATE"
"SEVEN_DAYS_AFTER_ISSUE_DATE"
"FIFTEEN_DAYS_AFTER_ISSUE_DATE"
"THIRTY_DAYS_AFTER_ISSUE_DATE"
"ONE_DAY_AFTER_DUE_DATE"
"SEVEN_DAYS_AFTER_DUE_DATE"
"FIFTEEN_DAYS_AFTER_DUE_DATE"
"THIRTY_DAYS_AFTER_DUE_DATE"

percentstring<percentage>Optional

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

auto_cancellationobject<recurring_auto_cancellation>Optional

The auto cancellation details for a recurring invoice. Since a series has no fixed issue date or due date, the cancellation trigger is expressed as a condition relative to each occurrence's due date rather than a single resolved calendar date.

recurring_auto_cancellation properties

1 property

conditionenum<conditional_rule_relative_conditions>Optional

Defines the time-based condition that triggers a conditional rule on a recurring invoice, expressed as a period relative to either the invoice issue date (for early payment discounts) or the invoice due date (for auto-cancellation).

Allowed values

"THREE_DAYS_AFTER_ISSUE_DATE"
"SEVEN_DAYS_AFTER_ISSUE_DATE"
"FIFTEEN_DAYS_AFTER_ISSUE_DATE"
"THIRTY_DAYS_AFTER_ISSUE_DATE"
"ONE_DAY_AFTER_DUE_DATE"
"SEVEN_DAYS_AFTER_DUE_DATE"
"FIFTEEN_DAYS_AFTER_DUE_DATE"
"THIRTY_DAYS_AFTER_DUE_DATE"

tip_presetsobject<tip_preset>[]Optional

Specifies the predefined tip options configured by the invoicer. These preset values are shown to customers at checkout as suggested tipping amounts, in addition to the option to enter a custom tip.

Items1 <= length <= 3

tip_preset properties

1 property

percentstring<percentage>Optional

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

invoicerobject<invoicer_info>Optional

The invoicer business information that appears on the invoice.

invoicer_info properties

10 properties

business_namestringOptional

Required. The business name of the party.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

person_name properties

7 properties

prefixstringOptional

The prefix, or title, to the party's name.

Match^.*$Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Match^.*$Length0 <= length <= 140

surnamestringOptional

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Match^.*$Length0 <= length <= 140

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Match^.*$Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Match^.*$Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

Match^.*$Length0 <= length <= 300

address_line_2stringOptional

The second line of the address, for example, a suite or apartment number.

Match^.*$Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Match^.*$Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Match^.*$Length0 <= length <= 100

admin_area_3stringOptional

The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, *bairro*, or neighborhood.
India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

Match^.*$Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Match^.*$Length0 <= length <= 120

admin_area_1stringOptional

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A *kanton*.

Match^.*$Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

address_detailsobject<Address Details>Optional

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

Address Details properties

6 properties

street_numberstringOptional

The street number.

Match^.*$Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Match^.*$Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Match^.*$Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Match^.*$Length0 <= length <= 100

building_namestringOptional

A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.

Match^.*$Length0 <= length <= 100

sub_buildingstringOptional

The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.

Match^.*$Length0 <= length <= 100

email_addressstring<restrictive_email_address>Optional

The internationalized email address with more restrictive rules. This version restricts the local-part to a dot-atom as defined in https://www.ietf.org/rfc/rfc5322.txt. It does not allow for a quoted-string or an obs-local-part.

Allows alphanumeric and RFC-allowed special characters, !#$%&'*+-/=?^_`{|}~
Ensures that the local part does not start with dot (.), have consecutive dots, or end with dot. Ensures that the domain part does not have consecutive dots.
Ensures that the local part does not exceed 64 characters.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Match^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$Length3 <= length <= 254

phonesobject<phone_detail>[]Optional

An array of invoicer's phone numbers. The invoicer can choose to hide the phone number on the invoice.

Items0 <= length <= 32767

phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

phone_typeenumRequired

The phone type.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

websitestringOptional

The invoicer's website.

FormaturiLength0 <= length <= 2048

tax_idstringOptional

The invoicer's tax ID.

Match^[\S\s]*$Length0 <= length <= 100

additional_notesstringOptional

Any additional information. Includes business hours.

Match^[\S\s]*$Length0 <= length <= 400

logo_urlstringOptional

The full URL to an external logo image. The logo image must not be larger than 250 pixels wide by 90 pixels high.

FormaturiLength0 <= length <= 2000

primary_recipientsobject<recipient_info>[]Required

The primary recipient of the recurring invoices. Contains billing and shipping information including the recipient's name, email address, physical address, phone number, and preferred language.

Items1 <= length <= 1

recipient_info properties

2 properties

billing_infoobject<billing_info>Optional

The billing information of the invoice recipient. Includes name, address, email, phone, and language.

billing_info properties

8 properties

business_namestringOptional

Required. The business name of the party.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

person_name properties

7 properties

prefixstringOptional

The prefix, or title, to the party's name.

Match^.*$Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Match^.*$Length0 <= length <= 140

surnamestringOptional

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Match^.*$Length0 <= length <= 140

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Match^.*$Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Match^.*$Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

Match^.*$Length0 <= length <= 300

address_line_2stringOptional

The second line of the address, for example, a suite or apartment number.

Match^.*$Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Match^.*$Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Match^.*$Length0 <= length <= 100

admin_area_3stringOptional

The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, *bairro*, or neighborhood.
India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

Match^.*$Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Match^.*$Length0 <= length <= 120

admin_area_1stringOptional

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A *kanton*.

Match^.*$Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

address_detailsobject<Address Details>Optional

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

Address Details properties

6 properties

street_numberstringOptional

The street number.

Match^.*$Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Match^.*$Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Match^.*$Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Match^.*$Length0 <= length <= 100

building_namestringOptional

A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.

Match^.*$Length0 <= length <= 100

sub_buildingstringOptional

The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.

Match^.*$Length0 <= length <= 100

email_addressstring<restrictive_email_address>Optional

The internationalized email address with more restrictive rules. This version restricts the local-part to a dot-atom as defined in https://www.ietf.org/rfc/rfc5322.txt. It does not allow for a quoted-string or an obs-local-part.

Allows alphanumeric and RFC-allowed special characters, !#$%&'*+-/=?^_`{|}~
Ensures that the local part does not start with dot (.), have consecutive dots, or end with dot. Ensures that the domain part does not have consecutive dots.
Ensures that the local part does not exceed 64 characters.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Match^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$Length3 <= length <= 254

phonesobject<phone_detail>[]Optional

The invoice recipient's phone numbers. Extension number is not supported.

Items0 <= length <= 32767

phone_detail properties

4 properties

country_codestringRequired

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

phone_typeenumRequired

The phone type.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

additional_infostringOptional

Any additional information about the recipient.

Match^[\S\s]*$Length0 <= length <= 40

languagestring<language>Optional

The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

shipping_infoobject<contact_name_address>Optional

The contact information of the user. Includes name and address.

contact_name_address properties

4 properties

business_namestringOptional

Required. The business name of the party.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

nameobject<person_name>Optional

The name of a person.

person_name properties

7 properties

prefixstringOptional

The prefix, or title, to the party's name.

Match^.*$Length0 <= length <= 140

given_namestringOptional

When the party is a person, the party's given, or first, name.

Match^.*$Length0 <= length <= 140

surnamestringOptional

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

Match^.*$Length0 <= length <= 140

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

Match^.*$Length0 <= length <= 140

suffixstringOptional

The suffix for the party's name.

Match^.*$Length0 <= length <= 140

full_namestringOptional

When the party is a person, the party's full name.

Match^.*$Length0 <= length <= 300

orthographyenum<orthography>Optional

The orthography type based on the ISO 15924 names for scripts. Scipts are chosen based on [most widely used writing systems](https://www.worldatlas.com/articles/the-world-s-most-popular-writing-scripts.html).

Allowed values

"Arab"
"Armn"
"Beng"
"Cans"
"Cyrl"
"Deva"
"Ethi"
"Geor"
"Grek"
"Gujr"
"Guru"
"Hani"

addressobject<address_portable>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

Match^.*$Length0 <= length <= 300

address_line_2stringOptional

The second line of the address, for example, a suite or apartment number.

Match^.*$Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. Examples include a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Match^.*$Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. This is smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code that is used in Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Match^.*$Length0 <= length <= 100

admin_area_3stringOptional

The sub-locality, suburb, neighborhood, or district. This is smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, *bairro*, or neighborhood.
India. Sub-locality or district. Street name information isn't always available, but a sub-locality or district can be a very small area.

Match^.*$Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Match^.*$Length0 <= length <= 120

admin_area_1stringOptional

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A *kanton*.

Match^.*$Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Match^.*$Length0 <= length <= 60

country_codestring<country_code>Required

The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

address_detailsobject<Address Details>Optional

The non-portable additional address details include fine-grain address information for Compliance, Risk, and other scenarios. This isn't portable with common third-party and open source applications. This can include data that is redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

Address Details properties

6 properties

street_numberstringOptional

The street number.

Match^.*$Length0 <= length <= 100

street_namestringOptional

The street name. Just `Drury` in `Drury Lane`.

Match^.*$Length0 <= length <= 100

street_typestringOptional

The street type. For example, avenue, boulevard, road, or expressway.

Match^.*$Length0 <= length <= 100

delivery_servicestringOptional

The delivery service. Post office box, bag number, or post office name.

Match^.*$Length0 <= length <= 100

building_namestringOptional

A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, Craven House.

Match^.*$Length0 <= length <= 100

sub_buildingstringOptional

The first-order entity below a named building or location that represents the sub-premise. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.

Match^.*$Length0 <= length <= 100

additional_recipientsarray<email_address>Optional

Additional email addresses to receive carbon copy (CC) notifications when invoices in this series are sent.

Items1 <= length <= 100

itemsobject<item>[]Optional

The line items that will appear on each invoice in the recurring series. Each item includes product or service details, quantity, unit price, and any applicable discounts or taxes.

Items1 <= length <= 100

item properties

9 properties

idstringOptional

The ID of the invoice line item.

Match^[\S\s]*$Length0 <= length <= 22

namestringRequired

The item name for the invoice line item.

Match^[\S\s]*$Length0 <= length <= 200

descriptionstringOptional

The item description for the invoice line item.

Match^[\S\s]*$Length0 <= length <= 1000

quantitystringRequired

The quantity of the item that the invoicer provides to the payer. Value is from `-1000000` to `1000000`. Supports up to five decimal places.

Match^\d+(.\d{1,5})?$Length0 <= length <= 14

unit_amountobject<money>Required

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

taxobject<tax>Optional

The tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.

tax properties

4 properties

namestringRequired

The name of the tax applied on the invoice items.

Match^[\s\S]*$Length0 <= length <= 100

percentstring<percentage>Required

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

tax_notestringOptional

The tax note used to track the tax related data.

Match^[\s\S]*$Length0 <= length <= 40

item_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). 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.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

discountobject<discount>Optional

The discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.

discount properties

2 properties

percentstring<percentage>Optional

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

unit_of_measureenum<unit_of_measure>Optional

The unit of measure for the invoiced item.

Allowed values

"QUANTITY"
"HOURS"
"AMOUNT"

configurationobject<recurring_configuration>Optional

The invoice configuration details. Includes partial payment, tip, and tax calculated after discount.

recurring_configuration properties

7 properties

tax_calculated_after_discountbooleanOptional

Indicates 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.

Defaulttrue

tax_inclusivebooleanOptional

Indicates whether the unit price includes tax.

Defaultfalse

allow_tipbooleanOptional

Indicates 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 in `Hong Kong`, `Taiwan`, `India`, or `Japan`.

Defaultfalse

partial_paymentobject<partial_payment>Optional

The partial payment details. Includes the minimum amount that the invoicer expects from the payer.

partial_payment properties

2 properties

allow_partial_paymentbooleanOptional

Indicates 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 in `India`, `Brazil`, or `Israel`.

Defaultfalse

minimum_amount_dueobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

template_idstringOptional

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.

Default"PayPal system template"Match^(TEMP-)[A-Z0-9]+$Length22 <= length <= 22

payment_method_overridesobject<override_payment_method_detail>[]Optional

The payment method override configurations for the recurring invoice. Defines which payment methods are enabled and any rules that control payment behavior. When provided during series creation or update, this array replaces any existing payment method override configuration for the series.

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.

Items1 <= length <= 15

override_payment_method_detail properties

3 properties

payment_method_typeenum<override_payment_method_type>Optional

The payment method types that can be configured in the payment method overrides object for invoice payments.

Note: To use PAY_BY_BANK, you must first complete the onboarding process. Visit the onboarding page to get started. Once onboarding is complete, you can configure PAY_BY_BANK as a payment method.

Allowed values

"PAY_BY_BANK"
"ACH"

enabledbooleanOptional

Indicates 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.

rulesobject<override_payment_method_rule>[]Optional

The 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.

Items1 <= length <= 10

override_payment_method_rule properties

2 properties

rule_typeenum<override_payment_method_rule_type>Required

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

Allowed values

"EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD"
"ALLOW_ONLY_ACH"

rule_valuestringRequired

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.

Match^[a-zA-Z0-9\s,.]+$Length1 <= length <= 100

themeobject<configurable_theme>Optional

The theme configuration that defines the visual appearance of the invoice buyer experience and email. Pass an empty object to use the default theme.

configurable_theme properties

1 property

primary_colorstringOptional

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.

Match^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$Length4 <= length <= 7

amountobject<amount_summary_detail>Optional

The invoice amount summary of item total, discount, tax total, and shipping.

amount_summary_detail properties

3 properties

currency_codestring<currency_code>Optional

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringOptional

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

breakdownobject<amount_with_breakdown>Optional

The breakdown of the amount. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.

amount_with_breakdown properties

5 properties

item_totalobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

discountobject<aggregated_discount>Optional

The discount. Can be an item- or invoice-level discount, or both. Can be applied as a percent or amount. If you provide both amount and percent, amount takes precedent.

aggregated_discount properties

2 properties

invoice_discountobject<discount>Optional

The discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.

discount properties

2 properties

percentstring<percentage>Optional

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

item_discountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

tax_totalobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

shippingobject<shipping_cost>Optional

The shipping fee for all items. Includes tax on shipping.

shipping_cost properties

2 properties

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

taxobject<tax>Optional

The tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.

tax properties

4 properties

namestringRequired

The name of the tax applied on the invoice items.

Match^[\s\S]*$Length0 <= length <= 100

percentstring<percentage>Required

The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 500

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

tax_notestringOptional

The tax note used to track the tax related data.

Match^[\s\S]*$Length0 <= length <= 40

customobject<custom_amount>Optional

The custom amount to apply to an invoice. If you include a label, you must include a custom amount.

custom_amount properties

2 properties

labelstringRequired

The label to the custom amount of the invoice.

Match^[\S\s]*$Length0 <= length <= 50

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [3-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

metadataobject<recurring_metadata>Optional

Comprehensive audit and tracking metadata that captures key lifecycle events and actions performed on the recurring invoice series, including creation, updates and cancellation.

recurring_metadata properties

5 properties

create_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[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})$Length20 <= length <= 64

created_bystringOptional

The email address of the account that created the resource.

Match^[\S\s]*$Length0 <= length <= 2147483647

last_update_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[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})$Length20 <= length <= 64

last_updated_bystringOptional

The email address of the account that last edited the resource.

Match^[\S\s]*$Length0 <= length <= 2147483647

canceled_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[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})$Length20 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 5

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^.*$Length0 <= length <= 20000

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 4

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^.*$Length0 <= length <= 20000

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Search recurring invoices series - response object.

recurring_series properties

plan properties

plan_frequency properties

recurring_info properties

recurring_series_detail properties

file_reference properties

recurring_payment_term properties

recurring_payment_term_conditional_rules properties

recurring_early_payment_discount properties

money properties

recurring_auto_cancellation properties

tip_preset properties

invoicer_info properties

person_name properties

address_portable properties

Address Details properties

phone_detail properties

recipient_info properties

billing_info properties

person_name properties

address_portable properties

Address Details properties

phone_detail properties

contact_name_address properties

person_name properties

address_portable properties

Address Details properties

item properties

money properties

tax properties

money properties

discount properties

money properties

recurring_configuration properties

partial_payment properties

money properties

override_payment_method_detail properties

override_payment_method_rule properties

configurable_theme properties

amount_summary_detail properties

amount_with_breakdown properties

money properties

aggregated_discount properties

discount properties

money properties

money properties

money properties

shipping_cost properties

money properties

tax properties

money properties

custom_amount properties

money properties

recurring_metadata properties

link_description properties

link_description properties

Back to top

On this page