0

PauseSubscription

by
Published Oct 17, 2025

Schedules a `PAUSE` action to pause an active subscription.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * PauseSubscription
7
 * Schedules a `PAUSE` action to pause an active subscription.
8
 */
9
export async function main(
10
  auth: Square,
11
  subscription_id: string,
12
  body: {
13
    pause_effective_date?: string;
14
    pause_cycle_duration?: number;
15
    resume_effective_date?: string;
16
    resume_change_timing?: "IMMEDIATE" | "END_OF_BILLING_CYCLE";
17
    pause_reason?: string;
18
  },
19
) {
20
  const url = new URL(
21
    `https://connect.squareup.com/v2/subscriptions/${subscription_id}/pause`,
22
  );
23

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