Pause Subscription - Automate.ax

square.pauseSubscription schedules a PAUSE action to pause an active subscription.

Example

automations/square-pause-subscription.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Pause Square Subscription", () => {
  onDashboardRun({ title: "Pause Square Subscription" })

  square.pauseSubscription({
    subscriptionId: "subscription_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_READ and INVOICES_WRITE and ITEMS_READ and ORDERS_WRITE and PAYMENTS_WRITE and SUBSCRIPTIONS_WRITE.

Field	Type	Required	Default	Description
`subscriptionId`	`string`	Yes	—	The ID of the subscription to pause.
`pauseEffectiveDate`	`string \| null`	No	—	The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. When this date is unspecified or falls within the current billing cycle, the subscription is paused on the starting date of the next billing cycle.
`pauseCycleDuration`	`bigint \| null`	No	—	The number of billing cycles the subscription will be paused before it is reactivated. When this is set, a `RESUME` action is also scheduled to take place on the subscription at the end of the specified pause cycle duration. In this case, neither `resume_effective_date` nor `resume_change_timing` may be specified.
`resumeEffectiveDate`	`string \| null`	No	—	The date when the subscription is reactivated by a scheduled `RESUME` action. This date must be at least one billing cycle ahead of `pause_effective_date`.
`resumeChangeTiming`	`Square.ChangeTiming`	No	—	The timing whether the subscription is reactivated immediately or at the end of the billing cycle, relative to `resume_effective_date`. See ChangeTiming for possible values
`pauseReason`	`string \| null`	No	—	The user-provided reason to pause the subscription.

Use the official PauseSubscription reference for provider field semantics and limits.

Output

Returns the official Square.PauseSubscriptionResponse response as a codec-safe object. Square integer money amounts remain bigint values.