On this page
No Headings
Search filters - to retrieve recurring invoices series.
Note:This API currently supports only one criterion for range queries, so specify only one of the following criteria: creation_date_range or next_occurrence_date_range.
objectcurrency_codestring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
statusarrayAn array of recurring invoice series status.
itemsstring"DRAFT", "ACTIVE", "CANCELLED", "EXPIRED"The lifecycle status of a recurring invoice series. Determines the operational state and whether invoices are actively being generated.
archivedbooleanIndicates whether to list merchant-archived recurring invoice series in the response. If 'true', the response lists only merchant-archived invoices. If 'false', the response lists only unarchived invoices. If 'null', the response defaults to false.
creation_date_rangeobjectThe date and time range. Filters invoices by creation date, invoice date, due date, and payment date.
startrequiredobject^[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 start date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
endrequiredobject^[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 end date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
Note: The regular expression provides guidance but does not reject all invalid dates.
^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T,t:[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$next_occurrence_date_rangeobjectThe date range. Filters invoices by creation date, invoice date, due date, and payment date.
startrequiredobject^[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 start date of the range. Filters invoices by creation date, invoice date, due date, and payment date.
endrequiredobject^[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 of the range. Filters invoices by creation date, invoice date, due date, and payment date.
total_amount_rangeobjectThe amount range.
lower_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The lower limit of the amount range.
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.upper_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The upper limit of the amount range.
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.