POST /v2/invoices/{invoice_id}/cancel
Cancels an invoice. The seller cannot collect payments for the canceled invoice.
You cannot cancel an invoice in the DRAFT state or in a terminal state: PAID, REFUNDED, CANCELED, or FAILED.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
invoice_id |
String | Yes |
The ID of the invoice to cancel. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
version |
Integer | Yes |
The version of the invoice to cancel. If you do not know the version, you can call GetInvoice or ListInvoices. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.