Update Subscription - Automate.ax

square.updateSubscription updates a subscription by modifying or clearing subscription field values.

Example

automations/square-update-subscription.automation.ts

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

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

  square.updateSubscription({
    subscriptionId: "subscription_id",
    subscription: {
      cardId: "{NEW CARD 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 update.
`subscription`	`Square.Subscription`	No	—	The subscription object containing the current version, and fields to update. Unset fields will be left at their current server values, and JSON `null` values will be treated as a request to clear the relevant data.

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

Output

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