On this page
No Headings
Oauth 2.0 authentication
Client CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheaderScopes
https://uri.paypal.com/services/invoicing/invoices/readwritehttps://uri.paypal.com/services/invoicing/internalA non-zero integer representing the page of the results.
11 <= value <= 1000A non-negative, non-zero integer indicating the maximum number of results to return at one time.
201 <= value <= 100Holds authorization information for external API calls.
^.*$1 <= length <= 16000application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api-m.sandbox.paypal.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"
}
]
}{
"name": "INVALID_REQUEST",
"message": "Request is not well-formed, syntactically incorrect, or violates schema.",
"debug_id": "e7c71c2e905fa",
"details": [
{
"field": "page_size",
"value": "1000",
"location": "query",
"issue": "INVALID_INTEGER_MAX_VALUE",
"description": "The integer value of a field is too large."
}
],
"links": [
{
"href": "https://developer.paypal.com/docs/api/invoicing/#errors",
"method": "GET"
}
]
}{
"name": "AUTHENTICATION_FAILURE",
"debug_id": "b1d1f06c7246c",
"message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}{
"name": "NOT_AUTHORIZED",
"debug_id": "b1d1f06c7246c",
"message": "Authorization failed due to insufficient permissions."
}{
"name": "string",
"message": "string",
"debug_id": "string",
"details": [],
"links": []
}{
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}{
"name": "INTERNAL_SERVER_ERROR",
"debug_id": "b1d1f06c7246c",
"message": "An internal server error has occurred."
}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.
^(?!\s*$).+$3 <= length <= 800Describes 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).
1 <= items <= 5Search 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.