Send invoice

POST

/v2/invoicing/invoices/{invoice_id}/send

Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date:

If the invoice issue date is current or in the past, sends the invoice immediately.
If the invoice issue date is in the future, schedules the invoice to be sent on that date.

To suppress the merchant's email notification, set the send_to_invoicer body parameter to false. To send the invoice through a share link and not through PayPal, set the send_to_recipient parameter to false in the notification object. The send_to_recipient parameter does not apply to a future issue date because the invoice is scheduled to be sent through PayPal on that date.

Notes:
After you send an invoice, resending it has no effect.
To send a notification for updates, update the invoice and set the send_to_recipient body parameter to true.

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

Header 参数

Body 参数application/json

示例

{
    "subject": "<The subject of the email that is sent as a notification to the recipient.>",
    "note": "<A note to the payer.>",
    "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}}/send' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "subject": "<The subject of the email that is sent as a notification to the recipient.>",
    "note": "<A note to the payer.>",
    "send_to_recipient": true,
    "additional_recipients": [
        "recipient_cc1@example.com",
        "recipient_cc2@example.com"
    ],
    "send_to_invoicer": false
}'

返回响应

🟢202202 - Send Invoice

application/json

Body

示例

{
    "href": "https://www.sandbox.paypal.com/invoice/p/#INV2-N63Q-LDN8-59GP-3G5A",
    "rel": "payer-view",
    "method": "GET"
}

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Invoice Not Found

🟠422422 Unprocessable Entity - Can Not Send Invoice

🟠422422 Unprocessable Entity - Invoice Already Sent

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

Fully update invoice

Send invoice reminder