Send invoice reminder

POST

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

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

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Path 参数

invoice_id

string

必需

(Required) The ID of the invoice for which to send a reminder.

示例值:

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

PayPal-Request-Id

string

必需

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.

示例值:

Body 参数application/json

subject

string

必需

note

string

必需

send_to_recipient

boolean

必需

additional_recipients

array[string]

必需

send_to_invoicer

boolean

必需

示例

{
  "subject": "Reminder: Payment due for the invoice #ABC-123",
  "note": "Please pay before the due date to avoid incurring late payment charges which will be adjusted in the next bill generated.",
  "send_to_recipient": true,
  "additional_recipients": [
    "recipient_cc1@example.com",
    "recipient_cc2@example.com"
  ],
  "send_to_invoicer": false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{{invoice_id}}/remind' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "subject": "Reminder: Payment due for the invoice #ABC-123",
    "note": "Please pay before the due date to avoid incurring late payment charges which will be adjusted in the next bill generated.",
    "send_to_recipient": true,
    "additional_recipients": [
        "recipient_cc1@example.com",
        "recipient_cc2@example.com"
    ],
    "send_to_invoicer": false
}'

返回响应

🟢204204 - Send Invoice Reminder

application/json

Body

object {0}

示例

{}

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Invoice Not Found

修改于 2023-08-16 07:18:59

Send invoice

Cancel sent invoice