Update invoice auto reminder configuration.

Updates an existing auto reminder configuration by providing the configuration ID and the updated settings in the request body. This operation allows modification of reminder timing intervals, repetition counts, and notification preferences. Note that this performs a full update of the configuration, so all required fields must be included in the request.

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.

typeenum<reminder_type>Required

The type of the auto reminder configuration.

Allowed values

"BEFORE_DUE"
"AFTER_DUE"

intervalobject<reminder_interval>Required

Defines the time interval used to determine when a reminder is sent relative to the invoice due date. The interval consists of a unit (for example, DAY) and a numeric value that specifies how many units before or after the due date the reminder is triggered.

repetitionintegerRequired

The repetition at which the auto reminder has to be set. Note: For `BEFORE_DUE` reminder type, repetition is always one.

Range1 <= value <= 7

notificationobject<reminder_notification>Optional

The email notification to send to the invoicer or payer on auto reminder configuration.

metadataobject<reminder_metadata>Optional

Invoice auto reminder configuration metadata.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/invoicing/reminders/RC-239531651S471944P" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Prefer: return=representation" \  -H "Content-Type: application/json" \  -d '{    "type": "BEFORE_DUE",    "interval": {      "unit": "DAY",      "value": 1    },    "repetition": 1  }'

{  "id": "RC-239531651S471944P",  "type": "BEFORE_DUE",  "status": "ACTIVE",  "interval": {    "unit": "DAY",    "value": 1  },  "repetition": 1,  "metadata": {    "created_time": "2026-01-28T03:31:53Z",    "updated_time": "2026-01-28T03:31:53Z"  },  "notification": {    "send_to_invoicer": false  },  "links": [    {      "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P",      "rel": "self",      "method": "GET"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P",      "rel": "replace",      "method": "PUT"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P/suspend",      "rel": "suspend",      "method": "POST"    },    {      "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P/resume",      "rel": "resume",      "method": "POST"    }  ]}

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

typeenum<reminder_type>Required

The type of the auto reminder configuration.

Allowed values

"BEFORE_DUE"
"AFTER_DUE"

intervalobject<reminder_interval>Required

repetitionintegerRequired

The repetition at which the auto reminder has to be set. Note: For `BEFORE_DUE` reminder type, repetition is always one.

Range1 <= value <= 7

notificationobject<reminder_notification>Optional

The email notification to send to the invoicer or payer on auto reminder configuration.

metadataobject<reminder_metadata>Optional

Invoice auto reminder configuration metadata.

curl -X PUT "https://example.com/v2/invoicing/reminders/RC-239531651S471944P" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "Prefer: return=representation" \ -H "Content-Type: application/json" \ -d '{ "type": "BEFORE_DUE", "interval": { "unit": "DAY", "value": 1 }, "repetition": 1 }'

{ "id": "RC-239531651S471944P", "type": "BEFORE_DUE", "status": "ACTIVE", "interval": { "unit": "DAY", "value": 1 }, "repetition": 1, "metadata": { "created_time": "2026-01-28T03:31:53Z", "updated_time": "2026-01-28T03:31:53Z" }, "notification": { "send_to_invoicer": false }, "links": [ { "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P", "rel": "self", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P", "rel": "replace", "method": "PUT" }, { "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P/suspend", "rel": "suspend", "method": "POST" }, { "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-239531651S471944P/resume", "rel": "resume", "method": "POST" } ]}

Authorization

Path Parameters

Header Parameters

Request Body

reminder_interval properties

reminder_notification properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Update invoice auto reminder configuration.

Authorization

Path Parameters

Header Parameters

Request Body

reminder_interval properties

reminder_notification properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Update invoice auto reminder configuration.

reminder_interval properties

reminder_notification properties

200application/json

204

400application/json

401application/json

403application/json

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

Update invoice auto reminder configuration.

reminder_interval properties

reminder_notification properties

200application/json

204

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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`