> ## 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 Terminal Action

> Cancels a Terminal action request if the status of the request permits it.

`square.cancelTerminalAction` cancels a Terminal action request if the status of the request permits it.

## Example

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

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

  square.cancelTerminalAction({
    actionId: "action_id",
  })
})
```

## Inputs

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

| Field      | Type     | Required | Default | Description                                 |
| ---------- | -------- | -------- | ------- | ------------------------------------------- |
| `actionId` | `string` | Yes      | —       | Unique ID for the desired `TerminalAction`. |

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

## Output

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