Search recurring invoices series.

Endpoint to search recurring invoice series based on search criteria. Note: Users are able to search only for the past 3 years.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite
Manage invoice resource internal clients.https://uri.paypal.com/services/invoicing/internal

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

search_textstringOptional

Describes the search text, which will be used to check if this particular search_text present in any of the recurring invoice series fields, specified by search_fields.

Match^(?!\s*$).+$Length3 <= length <= 800

search_fieldsarray<recurring_series_free_text_search_fields>Optional

Describes the set of fields on which the search will be performed.

Note:
If `search_fields` is provided with a single value 'ALL', the search will be performed across all the available fields in [search fields] (/recurring_series_free_text_search_fields.json).

Items1 <= length <= 5

search_filtersobject<recurring_series_search_filters>Optional

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.

recurring_series_search_filters properties

6 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

statusarray<recurring_status>Optional

An array of recurring invoice series status.

Items1 <= length <= 5

archivedbooleanOptional

Indicates 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_rangeobject<date_time_range>Optional

The date and time range. Filters invoices by creation date, invoice date, due date, and payment date.

next_occurrence_date_rangeobject<date_range>Optional

The date range. Filters invoices by creation date, invoice date, due date, and payment date.

total_amount_rangeobject<amount_range>Optional

The amount range.

Response Body

`application/json`

curl -X POST "https://example.com/v2/invoicing/search-recurring-invoices" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{}'

{  "recurring_invoices": [    {      "id": "stringstringstringst",      "status": "DRAFT",      "plan_detail": {        "total_cycles": 0,        "frequency": {          "interval_unit": "DAY",          "interval_count": 1        },        "start_series_date": "string",        "next_occurrence_date": "string",        "completed_cycles": 0      },      "recurring_info": {        "detail": {          "reference": "string",          "currency_code": "str",          "note": "string",          "terms_and_conditions": "string",          "memo": "string",          "attachments": [],          "payment_term": {            "term_type": "DUE_ON_RECEIPT",            "conditional_rules": {              "early_payment_discount": {                "discount_end_date": "string",                "percent": "string",                "amount": {                  "currency_code": "str",                  "value": "string"                },                "is_applied": true              },              "auto_cancellation": {                "cancel_by_date": "string",                "is_applied": true              }            }          }        },        "invoicer": {          "business_name": "string",          "orthography": "Arab",          "name": {            "prefix": "string",            "given_name": "string",            "surname": "string",            "middle_name": "string",            "suffix": "string",            "full_name": "string",            "orthography": "Arab"          },          "address": {            "address_line_1": "string",            "address_line_2": "string",            "address_line_3": "string",            "admin_area_4": "string",            "admin_area_3": "string",            "admin_area_2": "string",            "admin_area_1": "string",            "postal_code": "string",            "country_code": "st",            "address_details": {              "street_number": "string",              "street_name": "string",              "street_type": "string",              "delivery_service": "string",              "building_name": "string",              "sub_building": "string"            }          },          "email_address": "string",          "phones": [],          "website": "http://example.com",          "tax_id": "string",          "additional_notes": "string",          "logo_url": "http://example.com"        },        "primary_recipients": [          {            "billing_info": {              "business_name": "string",              "orthography": "Arab",              "name": {                "prefix": "string",                "given_name": "string",                "surname": "string",                "middle_name": "string",                "suffix": "string",                "full_name": "string",                "orthography": "Arab"              },              "address": {                "address_line_1": "string",                "address_line_2": "string",                "address_line_3": "string",                "admin_area_4": "string",                "admin_area_3": "string",                "admin_area_2": "string",                "admin_area_1": "string",                "postal_code": "string",                "country_code": "st",                "address_details": {                  "street_number": "string",                  "street_name": "string",                  "street_type": "string",                  "delivery_service": "string",                  "building_name": "string",                  "sub_building": "string"                }              },              "email_address": "string",              "phones": [],              "additional_info": "string",              "language": "string"            },            "shipping_info": {              "business_name": "string",              "orthography": "Arab",              "name": {                "prefix": "string",                "given_name": "string",                "surname": "string",                "middle_name": "string",                "suffix": "string",                "full_name": "string",                "orthography": "Arab"              },              "address": {                "address_line_1": "string",                "address_line_2": "string",                "address_line_3": "string",                "admin_area_4": "string",                "admin_area_3": "string",                "admin_area_2": "string",                "admin_area_1": "string",                "postal_code": "string",                "country_code": "st",                "address_details": {                  "street_number": "string",                  "street_name": "string",                  "street_type": "string",                  "delivery_service": "string",                  "building_name": "string",                  "sub_building": "string"                }              }            }          }        ],        "additional_recipients": [          "string"        ],        "items": [          {            "id": "string",            "name": "string",            "description": "string",            "quantity": "string",            "unit_amount": {              "currency_code": "str",              "value": "string"            },            "tax": {              "name": "string",              "percent": "string",              "amount": {                "currency_code": "str",                "value": "string"              },              "tax_note": "string"            },            "item_date": "string",            "discount": {              "percent": "string",              "amount": {                "currency_code": "str",                "value": "string"              }            },            "unit_of_measure": "QUANTITY"          }        ],        "configuration": {          "tax_calculated_after_discount": true,          "tax_inclusive": false,          "allow_tip": false,          "partial_payment": {            "allow_partial_payment": false,            "minimum_amount_due": {              "currency_code": "str",              "value": "string"            }          },          "template_id": "PayPal system template"        },        "amount": {          "currency_code": "str",          "value": "string",          "breakdown": {            "item_total": {              "currency_code": "str",              "value": "string"            },            "discount": {              "invoice_discount": {                "percent": "string",                "amount": {                  "currency_code": "str",                  "value": "string"                }              },              "item_discount": {                "currency_code": "str",                "value": "string"              }            },            "tax_total": {              "currency_code": "str",              "value": "string"            },            "shipping": {              "amount": {                "currency_code": "str",                "value": "string"              },              "tax": {                "name": "string",                "percent": "string",                "amount": {                  "currency_code": "str",                  "value": "string"                },                "tax_note": "string"              }            },            "custom": {              "label": "string",              "amount": {                "currency_code": "str",                "value": "string"              }            }          }        }      },      "metadata": {        "create_time": "string",        "created_by": "string",        "last_update_time": "string",        "last_updated_by": "string",        "canceled_time": "string"      },      "links": [        {          "href": "string",          "rel": "string",          "method": "CONNECT"        }      ]    }  ],  "links": [    {      "href": "string",      "rel": "string",      "method": "CONNECT"    }  ]}

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

search_textstringOptional

Describes the search text, which will be used to check if this particular search_text present in any of the recurring invoice series fields, specified by search_fields.

Match^(?!\s*$).+$Length3 <= length <= 800

search_fieldsarray<recurring_series_free_text_search_fields>Optional

Describes the set of fields on which the search will be performed.

Note:
If `search_fields` is provided with a single value 'ALL', the search will be performed across all the available fields in [search fields] (/recurring_series_free_text_search_fields.json).

Items1 <= length <= 5

search_filtersobject<recurring_series_search_filters>Optional

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.

recurring_series_search_filters properties

6 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

statusarray<recurring_status>Optional

An array of recurring invoice series status.

Items1 <= length <= 5

archivedbooleanOptional

creation_date_rangeobject<date_time_range>Optional

The date and time range. Filters invoices by creation date, invoice date, due date, and payment date.

next_occurrence_date_rangeobject<date_range>Optional

The date range. Filters invoices by creation date, invoice date, due date, and payment date.

total_amount_rangeobject<amount_range>Optional

The amount range.

curl -X POST "https://example.com/v2/invoicing/search-recurring-invoices" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "Content-Type: application/json" \ -d '{}'

{ "recurring_invoices": [ { "id": "stringstringstringst", "status": "DRAFT", "plan_detail": { "total_cycles": 0, "frequency": { "interval_unit": "DAY", "interval_count": 1 }, "start_series_date": "string", "next_occurrence_date": "string", "completed_cycles": 0 }, "recurring_info": { "detail": { "reference": "string", "currency_code": "str", "note": "string", "terms_and_conditions": "string", "memo": "string", "attachments": [], "payment_term": { "term_type": "DUE_ON_RECEIPT", "conditional_rules": { "early_payment_discount": { "discount_end_date": "string", "percent": "string", "amount": { "currency_code": "str", "value": "string" }, "is_applied": true }, "auto_cancellation": { "cancel_by_date": "string", "is_applied": true } } } }, "invoicer": { "business_name": "string", "orthography": "Arab", "name": { "prefix": "string", "given_name": "string", "surname": "string", "middle_name": "string", "suffix": "string", "full_name": "string", "orthography": "Arab" }, "address": { "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "admin_area_4": "string", "admin_area_3": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st", "address_details": { "street_number": "string", "street_name": "string", "street_type": "string", "delivery_service": "string", "building_name": "string", "sub_building": "string" } }, "email_address": "string", "phones": [], "website": "http://example.com", "tax_id": "string", "additional_notes": "string", "logo_url": "http://example.com" }, "primary_recipients": [ { "billing_info": { "business_name": "string", "orthography": "Arab", "name": { "prefix": "string", "given_name": "string", "surname": "string", "middle_name": "string", "suffix": "string", "full_name": "string", "orthography": "Arab" }, "address": { "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "admin_area_4": "string", "admin_area_3": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st", "address_details": { "street_number": "string", "street_name": "string", "street_type": "string", "delivery_service": "string", "building_name": "string", "sub_building": "string" } }, "email_address": "string", "phones": [], "additional_info": "string", "language": "string" }, "shipping_info": { "business_name": "string", "orthography": "Arab", "name": { "prefix": "string", "given_name": "string", "surname": "string", "middle_name": "string", "suffix": "string", "full_name": "string", "orthography": "Arab" }, "address": { "address_line_1": "string", "address_line_2": "string", "address_line_3": "string", "admin_area_4": "string", "admin_area_3": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st", "address_details": { "street_number": "string", "street_name": "string", "street_type": "string", "delivery_service": "string", "building_name": "string", "sub_building": "string" } } } } ], "additional_recipients": [ "string" ], "items": [ { "id": "string", "name": "string", "description": "string", "quantity": "string", "unit_amount": { "currency_code": "str", "value": "string" }, "tax": { "name": "string", "percent": "string", "amount": { "currency_code": "str", "value": "string" }, "tax_note": "string" }, "item_date": "string", "discount": { "percent": "string", "amount": { "currency_code": "str", "value": "string" } }, "unit_of_measure": "QUANTITY" } ], "configuration": { "tax_calculated_after_discount": true, "tax_inclusive": false, "allow_tip": false, "partial_payment": { "allow_partial_payment": false, "minimum_amount_due": { "currency_code": "str", "value": "string" } }, "template_id": "PayPal system template" }, "amount": { "currency_code": "str", "value": "string", "breakdown": { "item_total": { "currency_code": "str", "value": "string" }, "discount": { "invoice_discount": { "percent": "string", "amount": { "currency_code": "str", "value": "string" } }, "item_discount": { "currency_code": "str", "value": "string" } }, "tax_total": { "currency_code": "str", "value": "string" }, "shipping": { "amount": { "currency_code": "str", "value": "string" }, "tax": { "name": "string", "percent": "string", "amount": { "currency_code": "str", "value": "string" }, "tax_note": "string" } }, "custom": { "label": "string", "amount": { "currency_code": "str", "value": "string" } } } } }, "metadata": { "create_time": "string", "created_by": "string", "last_update_time": "string", "last_updated_by": "string", "canceled_time": "string" }, "links": [ { "href": "string", "rel": "string", "method": "CONNECT" } ] } ], "links": [ { "href": "string", "rel": "string", "method": "CONNECT" } ]}

recurring_series_search_filters properties

date_time_range properties

date_range properties

amount_range properties

money properties

money properties

200application/json

400application/json

401application/json

403application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Search recurring invoices series.

recurring_series_search_filters properties

date_time_range properties

date_range properties

amount_range properties

money properties

money properties

200application/json

400application/json

401application/json

403application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`