Cancel sent invoice

Deprecation notice: The /v1/invoices endpoint is deprecated. Use the /v2/invoices endpoint instead. For details, see PayPal Invoicing Basic Integration.

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

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage invoice resource.https://uri.paypal.com/services/invoicing

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subjectstringOptional

The subject of the notification. If left blank we include a generic subject.

notestringOptional

A note to the payer.

send_to_merchantbooleanOptional

Indicates whether to send the notification to the merchant.

Defaulttrue

send_to_payerbooleanOptional

Indicates whether to send the notification to the payer.

Defaulttrue

cc_emailsarray<cc_emails>Optional

An array of one or more CC: emails to which to send notification emails. If you omit this parameter, the API sends notification emails to all CC: email addresses that are part of the invoice.

Note: Additional email addresses are not supported.

Items0 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/invoicing/invoices/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subjectstringOptional

The subject of the notification. If left blank we include a generic subject.

notestringOptional

A note to the payer.

send_to_merchantbooleanOptional

Indicates whether to send the notification to the merchant.

Defaulttrue

send_to_payerbooleanOptional

Indicates whether to send the notification to the payer.

Defaulttrue

cc_emailsarray<cc_emails>Optional

An array of one or more CC: emails to which to send notification emails. If you omit this parameter, the API sends notification emails to all CC: email addresses that are part of the invoice.

Note: Additional email addresses are not supported.

Items0 <= length <= 100

Authorization

Path Parameters

Request Body

Response Body

`application/json`

On this page

On this page

On this page

Cancel sent invoice

Authorization

Path Parameters

Request Body

Response Body

`application/json`

On this page

On this page

Cancel sent invoice

204

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Cancel sent invoice

204

defaultapplication/json

On this page

On this page

`application/json`

`application/json`