Cancel sent invoice

POST

/v2/invoicing/invoices/{invoice_id}/cancel

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and CC: emails.

请求参数

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_invoicer": true,
    "send_to_recipient": true,
    "additional_recipients": [
        "user_in_cc@example.com"
    ]
}

请求示例代码

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}}/cancel' \
--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_invoicer": true,
    "send_to_recipient": true,
    "additional_recipients": [
        "user_in_cc@example.com"
    ]
}'

返回响应

🟢204204 - Cancel Sent Invoice

application/json

Body

示例

{}

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Invoice Not Found

🟠422422 Unprocessable Entity - Can Not Cancel Draft Invoice

🟠422422 Unprocessable Entity - Invoice Canceled Already

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

Send invoice reminder

Delete invoice