Update recurring invoice series details

API v2

API v1

Update recurring invoice series details by ID.

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

Path Parameters

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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.

recurring_infoobject<recurring_info>Required

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

Response Body

`application/json`

curl -X PUT "https://example.com/v2/invoicing/recurring-invoices/RI-5VG36420NF0175035" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "plan_detail": {      "total_cycles": 8,      "frequency": {        "interval_unit": "MONTH",        "interval_count": 2      },      "start_series_date": "2026-01-19"    },    "recurring_info": {      "detail": {        "reference": "0002",        "currency_code": "USD",        "note": "Thank you",        "terms_and_conditions": "Your terms and conditions",        "memo": "Gift pack",        "category_code": "SHIPPABLE",        "payment_term": {          "term_type": "DUE_ON_RECEIPT"        }      },      "primary_recipients": [        {          "billing_info": {            "email_address": "test@paypal.com"          }        }      ],      "items": [        {          "name": "pen",          "quantity": "2",          "unit_amount": {            "currency_code": "USD",            "value": "12.00"          },          "unit_of_measure": "QUANTITY"        }      ],      "configuration": {        "tax_calculated_after_discount": true,        "tax_inclusive": false,        "allow_tip": true,        "partial_payment": {          "allow_partial_payment": true,          "minimum_amount_due": {            "currency_code": "USD",            "value": "2.00"          }        }      }    }  }'

{  "id": "RI-9Y6699772R098892C",  "status": "ACTIVE",  "plan_detail": {    "total_cycles": 8,    "frequency": {      "interval_unit": "MONTH",      "interval_count": 1    },    "start_series_date": "2026-01-19",    "completed_cycles": 0  },  "recurring_info": {    "detail": {      "reference": "0001",      "currency_code": "USD",      "note": "Thank you",      "terms_and_conditions": "Your terms and conditions",      "memo": "Gift pack",      "category_code": "SHIPPABLE",      "payment_term": {        "term_type": "DUE_ON_RECEIPT"      }    },    "primary_recipients": [      {        "billing_info": {          "email_address": "test@paypal.com"        }      }    ],    "items": [      {        "id": "ITEM-3LD558161T864042C",        "name": "pen",        "quantity": "1",        "unit_amount": {          "currency_code": "USD",          "value": "12.00"        },        "unit_of_measure": "QUANTITY"      }    ],    "configuration": {      "tax_calculated_after_discount": true,      "tax_inclusive": false,      "allow_tip": true,      "partial_payment": {        "allow_partial_payment": true,        "minimum_amount_due": {          "currency_code": "USD",          "value": "2.00"        }      },      "template_id": "TEMP-1B23377148371954V"    },    "amount": {      "breakdown": {        "item_total": {          "currency_code": "USD",          "value": "12.00"        },        "discount": {          "invoice_discount": {            "amount": {              "currency_code": "USD",              "value": "0.00"            }          },          "item_discount": {            "currency_code": "USD",            "value": "0.00"          }        },        "tax_total": {          "currency_code": "USD",          "value": "0.00"        }      },      "currency_code": "USD",      "value": "12.00"    }  },  "metadata": {    "create_time": "2026-01-20T05:17:06Z",    "last_update_time": "2026-01-20T05:17:06Z"  },  "links": [    {      "href": "https://api-m.paypal.com/v2/invoicing/recurring-invoices/RI-8K163274UC7208201",      "rel": "self",      "method": "GET"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/recurring-invoices/RI-8K163274UC7208201",      "rel": "delete",      "method": "DELETE"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/recurring-invoices/RI-8K163274UC7208201",      "rel": "replace",      "method": "PUT"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/recurring-invoices/RI-8K163274UC7208201/cancel",      "rel": "cancel",      "method": "POST"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/recurring-invoices/RI-8K163274UC7208201/activate",      "rel": "activate",      "method": "POST"    }  ]}

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

Authorization

Path Parameters

Header Parameters

Request Body

plan properties

plan_frequency properties

recurring_info properties

recurring_series_detail properties

file_reference properties

payment_term properties

payment_term_conditional_rules properties

early_payment_discount properties

money properties

auto_cancellation 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

discount properties

money properties

recurring_configuration properties

partial_payment properties

money 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

custom_amount properties

money properties

Response Body

200application/json

400application/json

401application/json

403application/json

404application/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`