Change Billing Anchor Date - Automate.ax

square.changeBillingAnchorDate changes the billing anchor date for a subscription.

Example

automations/square-change-billing-anchor-date.automation.ts

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

export default automation("Change Square Billing Anchor Date", () => {
  onDashboardRun({ title: "Change Square Billing Anchor Date" })

  square.changeBillingAnchorDate({
    subscriptionId: "subscription_id",
    monthlyBillingAnchorDate: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_READ and SUBSCRIPTIONS_READ and SUBSCRIPTIONS_WRITE.

Field	Type	Required	Default	Description
`subscriptionId`	`string`	Yes	—	The ID of the subscription to update the billing anchor date.
`monthlyBillingAnchorDate`	`number \| null`	No	—	The anchor day for the billing cycle.
`effectiveDate`	`string \| null`	No	—	The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes place on the subscription. When this date is unspecified or falls within the current billing cycle, the billing anchor date is changed immediately.

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

Output

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