Resume Subscription - Automate.ax

square.resumeSubscription schedules a RESUME action to resume a paused or a deactivated subscription.

Example

automations/square-resume-subscription.automation.ts

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

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

  square.resumeSubscription({
    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 resume.
`resumeEffectiveDate`	`string \| null`	No	—	The `YYYY-MM-DD`-formatted date when the subscription reactivated.
`resumeChangeTiming`	`Square.ChangeTiming`	No	—	The timing to resume a subscription, relative to the specified `resume_effective_date` attribute value. See ChangeTiming for possible values

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

Output

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