Send invoice reminder

Deprecation notice: The /v1/invoices endpoint is deprecated. Use the /v2/invoices endpoint instead. For details, see PayPal Invoicing Basic Integration.

Sends a reminder to the payer about an invoice, by ID. In the JSON request body, include a `notification` object that defines the subject of the reminder and other details.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage invoice resource.https://uri.paypal.com/services/invoicing

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subjectstringOptional

The subject of the notification. Default is a generic subject.

notestringOptional

A note to the payer.

send_to_merchantbooleanOptional

Indicates whether to send a copy of the email to the merchant.

Defaulttrue

cc_emailsarray<cc_emails>Optional

An array of one or more CC: emails to which to send notification emails. If you omit this parameter, the API sends notification emails to all CC: email addresses that are part of the invoice.

Note: Valid values are email addresses in the `cc_info` array of the invoice.

Items0 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoicing/invoices/string/remind" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Send invoice reminder

API v2

API v1

Deprecation notice: The /v1/invoices endpoint is deprecated. Use the /v2/invoices endpoint instead. For details, see PayPal Invoicing Basic Integration.

Sends a reminder to the payer about an invoice, by ID. In the JSON request body, include a `notification` object that defines the subject of the reminder and other details.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage invoice resource.https://uri.paypal.com/services/invoicing

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subjectstringOptional

The subject of the notification. Default is a generic subject.

notestringOptional

A note to the payer.

send_to_merchantbooleanOptional

Indicates whether to send a copy of the email to the merchant.

Defaulttrue

cc_emailsarray<cc_emails>Optional

An array of one or more CC: emails to which to send notification emails. If you omit this parameter, the API sends notification emails to all CC: email addresses that are part of the invoice.

Note: Valid values are email addresses in the `cc_info` array of the invoice.

Items0 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoicing/invoices/string/remind" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Send invoice reminder

Authorization

Path Parameters

Request Body

Response Body

`application/json`

On this page

On this page

On this page

Send invoice reminder

Authorization

Path Parameters

Request Body

Response Body

`application/json`

On this page

On this page

Send invoice reminder

202

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

Send invoice reminder

202

defaultapplication/json

On this page

On this page

`application/json`

`application/json`