0

DeleteCustomer

by
Published Oct 17, 2025

Deletes a customer profile from a business. This operation also unlinks any associated cards on file. To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * DeleteCustomer
7
 * Deletes a customer profile from a business. This operation also unlinks any associated cards on file.
8

9
To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.
10
 */
11
export async function main(
12
  auth: Square,
13
  customer_id: string,
14
  version: string | undefined,
15
) {
16
  const url = new URL(
17
    `https://connect.squareup.com/v2/customers/${customer_id}`,
18
  );
19
  for (const [k, v] of [["version", version]]) {
20
    if (v !== undefined && v !== "" && k !== undefined) {
21
      url.searchParams.append(k, v);
22
    }
23
  }
24
  const response = await fetch(url, {
25
    method: "DELETE",
26
    headers: {
27
      Authorization: "Bearer " + auth.token,
28
    },
29
    body: undefined,
30
  });
31
  if (!response.ok) {
32
    const text = await response.text();
33
    throw new Error(`${response.status} ${text}`);
34
  }
35
  return await response.json();
36
}
37