• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Cancel invoice BETA

POST /v2/invoices/{invoice_id}/cancel

Cancels an invoice.

The seller cannot collect payments for the canceled invoice.

You cannot cancel an invoice in a terminal state: PAID, REFUNDED, CANCELED, or FAILED.


Permissions
ORDERS_WRITE
INVOICES_WRITE
Try in API Explorer
Name Description
invoice_id
string

Required

The ID of the invoice to cancel.

Name Description
version
integer

Required

The version of the invoice to cancel. If you do not know the version, you can call GetInvoice or ListInvoices.

Response Fields

Name Description
invoice
Invoice

The canceled invoice.

errors
Error [ ]

Information about errors encountered during the request.

Examples

You are viewing an old version of the API
POST /v2/invoices/{invoice_id}/cancel
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/invoices/gt2zv1z6mnUm1V7KMxxf3w/cancel \
  -X POST \
  -H 'Square-Version: 2020-08-12' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": 0
  }'
Response JSON
{
  "invoice": {
    "id": "gt2zv1z6mnUm1V7KMxxf3w",
    "version": 1,
    "location_id": "ES0RJRZYEC39A",
    "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
    "payment_requests": [
      {
        "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355",
        "request_method": "EMAIL",
        "request_type": "BALANCE",
        "due_date": "2030-01-24",
        "tipping_enabled": true,
        "reminders": [
          {
            "uid": "beebd363-e47f-4075-8785-c235aaa7df11",
            "relative_scheduled_days": -1,
            "message": "Your invoice is due tomorrow",
            "status": "PENDING"
          }
        ],
        "computed_amount_money": {
          "amount": 10000,
          "currency": "USD"
        },
        "total_completed_amount_money": {
          "amount": 0,
          "currency": "USD"
        }
      }
    ],
    "invoice_number": "inv-100",
    "title": "Event Planning Services",
    "description": "We appreciate your business!",
    "scheduled_at": "2030-01-13T10:00:00Z",
    "status": "CANCELED",
    "timezone": "America/Los_Angeles",
    "created_at": "2020-06-18T17:45:13Z",
    "updated_at": "2020-06-18T18:23:11Z",
    "primary_recipient": {
      "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
      "given_name": "Amelia",
      "family_name": "Earhart",
      "email_address": "Amelia.Earhart@example.com",
      "phone_number": "1-212-555-4240"
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?