0

CancelSubscription

by
Published Oct 17, 2025

Schedules a `CANCEL` action to cancel an active subscription. This sets the `canceled_date` field to the end of the active billing period. After this date, the subscription status changes from ACTIVE to CANCELED.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * CancelSubscription
7
 * Schedules a `CANCEL` action to cancel an active subscription. This 
8
sets the `canceled_date` field to the end of the active billing period. After this date, 
9
the subscription status changes from ACTIVE to CANCELED.
10
 */
11
export async function main(auth: Square, subscription_id: string) {
12
  const url = new URL(
13
    `https://connect.squareup.com/v2/subscriptions/${subscription_id}/cancel`,
14
  );
15

16
  const response = await fetch(url, {
17
    method: "POST",
18
    headers: {
19
      Authorization: "Bearer " + auth.token,
20
    },
21
    body: undefined,
22
  });
23
  if (!response.ok) {
24
    const text = await response.text();
25
    throw new Error(`${response.status} ${text}`);
26
  }
27
  return await response.json();
28
}
29