0

CancelInvoice

by
Published Oct 17, 2025

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`.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * CancelInvoice
7
 * Cancels an invoice. The seller cannot collect payments for 
8
the canceled invoice.
9

10
You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`.
11
 */
12
export async function main(
13
  auth: Square,
14
  invoice_id: string,
15
  body: { version: number },
16
) {
17
  const url = new URL(
18
    `https://connect.squareup.com/v2/invoices/${invoice_id}/cancel`,
19
  );
20

21
  const response = await fetch(url, {
22
    method: "POST",
23
    headers: {
24
      "Content-Type": "application/json",
25
      Authorization: "Bearer " + auth.token,
26
    },
27
    body: JSON.stringify(body),
28
  });
29
  if (!response.ok) {
30
    const text = await response.text();
31
    throw new Error(`${response.status} ${text}`);
32
  }
33
  return await response.json();
34
}
35