0

DeleteOrderCustomAttribute

by
Published Oct 17, 2025

Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile. To delete a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * DeleteOrderCustomAttribute
7
 * Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
8

9
To delete a custom attribute owned by another application, the `visibility` setting must be
10
`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
11
(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
12
 */
13
export async function main(
14
  auth: Square,
15
  order_id: string,
16
  custom_attribute_key: string,
17
) {
18
  const url = new URL(
19
    `https://connect.squareup.com/v2/orders/${order_id}/custom-attributes/${custom_attribute_key}`,
20
  );
21

22
  const response = await fetch(url, {
23
    method: "DELETE",
24
    headers: {
25
      Authorization: "Bearer " + auth.token,
26
    },
27
    body: undefined,
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