Send Invoice Reminder
Merchants can send customers a reminder to pay an invoice.
- Call the remind method. Include the invoice ID in the URI of the request. By default, the reminder includes a generic subject and note and sends a copy of the email to the merchant.
- To customize the invoice details, include a
notification
object in the JSON request body. Here you can set the subject line and write a note to the customer. - Set
send_to_invoicer
totrue
to send a copy of the email to the merchant. - Set the
additional_recipients
array to send a CC:email to anyone the merchant needs to notify.
This sample request sends an invoice reminder:
curl -v -X POST \
https://api-m.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/remind \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <Access-Token>" \
-d '{
"subject": "Past due",
"note": "Please submit a payment at your earliest convenience.",
"send_to_invoicer": true,
"additional_recipients": ["recipient@example.com"]
}'
A successful request returns the HTTP 202 Accepted
status code with no JSON response body.
Next
Continue to Mark Invoice as Paid.