PApaypal
invoices

Cancel sent invoice

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

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

Request

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><strong>Note:</strong> 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><strong>Note:</strong> 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><strong>Note:</strong> 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.