invoices

Send invoice reminder

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. <blockquote>Notes:<ul><li>API caller can send only 2 reminders in a day.</li></ul></blockquote>.

post/v2/invoicing/invoices/{invoice_id}/remind

Request

Base URL
https://api-m.paypal.com
Auth
OAuth 2
Client credentials
Token URL/v1/oauth2/token
Scopeshttps://uri.paypal.com/services/invoicing/invoices/readwrite
TypeScript
https://skmtc.dev/paypal/apis/payments/docs/v2/invoicing/invoices/:invoice_id/remind/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

invoice_idstring required

The ID of the draft invoice to delete.

Request body

subjectstring

The subject of the email that is sent as a notification to the recipient.<blockquote>Note: User-provided values for this field will not be honored and the subject will always be defaulted to a system-defined value.</blockquote>

notestring

A note to the payer.<blockquote>Note: User-provided values for this field will not be honored and the note will always be defaulted to a system-defined value.</blockquote>

send_to_invoicerboolean

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

send_to_recipientboolean

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

additional_recipientsEmailAddress[]

An array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.<blockquote>Note: Valid values are email addresses in the additional_recipients value associated with the invoice.</blockquote>

Response

A successful request returns the HTTP 204 No Content status code with no JSON response body.

Changes

No recorded changes to this operation across all 1 revision of this API.