Setup auto reminder configuration.

Initializes the auto reminder configuration for a merchant account. This controller resource accepts an optional array of reminder configuration objects. A maximum of two reminder types are supported: BEFORE_DUE and AFTER_DUE.

Implementation behavior:

If both reminder types are provided in the request payload, both reminders are created using the supplied configuration and are set to ACTIVE state.
If only one reminder type is provided, the provided reminder is created using the supplied configuration and is set to ACTIVE state. The missing reminder type is automatically created using the default configuration and is set to INACTIVE state.
If the request payload is empty, both BEFORE_DUE and AFTER_DUE reminders are created using the default configuration and are set to INACTIVE state.

Default configuration values:

BEFORE_DUE: interval_unit = DAY, interval_value = 2, repetition = 1, send_to_invoicer = false
AFTER_DUE: interval_unit = DAY, interval_value = 2, repetition = 2, send_to_invoicer = false

Note: After successful execution, both reminder configurations (BEFORE_DUE and AFTER_DUE) will exist for the merchant account. If reminder configurations already exist for the merchant account, the request fails with a 422 Unprocessable Entity error.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.sandbox.paypal.com/v2/invoicing/setup-reminders" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "configurations": [      {        "type": "BEFORE_DUE",        "interval": {          "unit": "DAY",          "value": 2        },        "repetition": 1,        "notification": {          "send_to_invoicer": false        }      },      {        "type": "AFTER_DUE",        "interval": {          "unit": "DAY",          "value": 2        },        "repetition": 2,        "notification": {          "send_to_invoicer": false        }      }    ]  }'

{
  "configurations": [
    {
      "id": "RC-239531651S471944P",
      "type": "BEFORE_DUE",
      "status": "ACTIVE",
      "interval": {
        "unit": "DAY",
        "value": 2
      },
      "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"
        }
      ]
    },
    {
      "id": "RC-19C40543NJ101123L",
      "type": "AFTER_DUE",
      "status": "ACTIVE",
      "interval": {
        "unit": "DAY",
        "value": 2
      },
      "repetition": 2,
      "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-19C40543NJ101123L",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-19C40543NJ101123L",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-19C40543NJ101123L/suspend",
          "rel": "suspend",
          "method": "POST"
        },
        {
          "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-19C40543NJ101123L/resume",
          "rel": "resume",
          "method": "POST"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/invoicing/reminders",
      "rel": "collection",
      "method": "GET"
    }
  ]
}

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

Setup auto reminder configuration.

API v2

API v1

Implementation behavior:

If both reminder types are provided in the request payload, both reminders are created using the supplied configuration and are set to ACTIVE state.
If only one reminder type is provided, the provided reminder is created using the supplied configuration and is set to ACTIVE state. The missing reminder type is automatically created using the default configuration and is set to INACTIVE state.
If the request payload is empty, both BEFORE_DUE and AFTER_DUE reminders are created using the default configuration and are set to INACTIVE state.

Default configuration values:

BEFORE_DUE: interval_unit = DAY, interval_value = 2, repetition = 1, send_to_invoicer = false
AFTER_DUE: interval_unit = DAY, interval_value = 2, repetition = 2, send_to_invoicer = false

Note: After successful execution, both reminder configurations (BEFORE_DUE and AFTER_DUE) will exist for the merchant account. If reminder configurations already exist for the merchant account, the request fails with a 422 Unprocessable Entity error.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

configurations?array<>

An array of invoice auto reminder configurations. The array can contain a maximum of two configurations, one for BEFORE_DUE reminder type and one for AFTER_DUE reminder type.

Items1 <= items <= 2

Response Body

`application/json`

curl -X POST "https://api-m.sandbox.paypal.com/v2/invoicing/setup-reminders" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "configurations": [      {        "type": "BEFORE_DUE",        "interval": {          "unit": "DAY",          "value": 2        },        "repetition": 1,        "notification": {          "send_to_invoicer": false        }      },      {        "type": "AFTER_DUE",        "interval": {          "unit": "DAY",          "value": 2        },        "repetition": 2,        "notification": {          "send_to_invoicer": false        }      }    ]  }'

{
  "configurations": [
    {
      "id": "RC-239531651S471944P",
      "type": "BEFORE_DUE",
      "status": "ACTIVE",
      "interval": {
        "unit": "DAY",
        "value": 2
      },
      "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"
        }
      ]
    },
    {
      "id": "RC-19C40543NJ101123L",
      "type": "AFTER_DUE",
      "status": "ACTIVE",
      "interval": {
        "unit": "DAY",
        "value": 2
      },
      "repetition": 2,
      "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-19C40543NJ101123L",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-19C40543NJ101123L",
          "rel": "replace",
          "method": "PUT"
        },
        {
          "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-19C40543NJ101123L/suspend",
          "rel": "suspend",
          "method": "POST"
        },
        {
          "href": "https://api-m.paypal.com/v2/invoicing/reminders/RC-19C40543NJ101123L/resume",
          "rel": "resume",
          "method": "POST"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api-m.paypal.com/v2/invoicing/reminders",
      "rel": "collection",
      "method": "GET"
    }
  ]
}

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

Setup auto reminder configuration.

200application/json

400application/json

401application/json

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

Setup auto reminder configuration.

200application/json

400application/json

401application/json

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