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>

Oauth 2.0 authentication

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

id*string

The ID of the auto reminder configuration to be updated.

Match^RC-[A-Z0-9]+$

Length20 <= length <= 20

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Prefer?string

The Prefer request header field is used to indicate that particular server behavior is preferred by the client but is not required for successful completion of the request. For example, the value 'return=representation' indicates that the client prefers that the API server include an entity representing the current state of the resource in the response to a successful request.

Match^.*$

Length1 <= length <= 16000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://api-m.sandbox.paypal.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"
    }
  ]
}

Empty

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "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": "RESOURCE_NOT_FOUND",
  "message": "The specified resource does not exist.",
  "debug_id": "3ea444214c04b",
  "details": [
    {
      "field": "id",
      "value": "RC-239531651S471944C",
      "location": "path",
      "issue": "INVALID_RESOURCE_ID",
      "description": "The requested resource ID was not found."
    }
  ],
  "links": [
    {
      "href": "https://developer.paypal.com/docs/api/invoicing/#errors",
      "method": "GET"
    }
  ]
}

{
  "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."
}

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Prefer?string

Match^.*$

Length1 <= length <= 16000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*reminder_type

The type of the auto reminder configuration.

Value in"BEFORE_DUE" | "AFTER_DUE"

interval*

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.

repetition*integer

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

Range1 <= value <= 7

notification?

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

metadata?

Invoice auto reminder configuration metadata.

curl -X PUT "https://api-m.sandbox.paypal.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" } ] }

{ "name": "RESOURCE_NOT_FOUND", "message": "The specified resource does not exist.", "debug_id": "3ea444214c04b", "details": [ { "field": "id", "value": "RC-239531651S471944C", "location": "path", "issue": "INVALID_RESOURCE_ID", "description": "The requested resource ID was not found." } ], "links": [ { "href": "https://developer.paypal.com/docs/api/invoicing/#errors", "method": "GET" } ] }

Update invoice auto reminder configuration.

200application/json

204

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

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.

200application/json

204

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/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`

`application/json`