Get all invoice auto reminder configuration.

Retrieves all auto reminder configurations associated with the merchant account. This operation returns both BEFORE_DUE and AFTER_DUE reminder configurations, regardless of their current status (ACTIVE or INACTIVE). Each configuration includes complete details such as timing intervals, repetition counts, notification preferences, status information, creation and update timestamps, and HATEOAS links for managing the configurations.

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

Query Parameters

type?string

Filters reminder configurations by reminder type. If not provided, all reminder configurations (BEFORE_DUE and AFTER_DUE) are returned.

Value in"BEFORE_DUE" | "AFTER_DUE"

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Response Body

`application/json`

curl -X GET "https://api-m.sandbox.paypal.com/v2/invoicing/reminders" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"

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

Get all invoice auto reminder configuration.

API v2

API v1

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

Query Parameters

type?string

Filters reminder configurations by reminder type. If not provided, all reminder configurations (BEFORE_DUE and AFTER_DUE) are returned.

Value in"BEFORE_DUE" | "AFTER_DUE"

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Response Body

`application/json`

curl -X GET "https://api-m.sandbox.paypal.com/v2/invoicing/reminders" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"

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

Get all invoice auto reminder configuration.

200application/json

400application/json

401application/json

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

Get all invoice auto reminder configuration.

200application/json

400application/json

401application/json

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