> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Cancel Subscription

> Schedules a `CANCEL` action to cancel an active subscription.

`square.cancelSubscription` schedules a `CANCEL` action to cancel an active subscription.

## Example

```ts automations/square-cancel-subscription.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

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

  square.cancelSubscription({
    subscriptionId: "subscription_id",
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `SUBSCRIPTIONS_WRITE`.

| Field            | Type     | Required | Default | Description                           |
| ---------------- | -------- | -------- | ------- | ------------------------------------- |
| `subscriptionId` | `string` | Yes      | —       | The ID of the subscription to cancel. |

Use the official [CancelSubscription reference](https://developer.squareup.com/reference/square/subscriptions-api/cancel-subscription) for provider field semantics and limits.

## Output

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