> ## 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 Checkout

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

`square.cancelTerminalCheckout` cancels a Terminal checkout request if the status of the request permits it.

## Example

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

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

  square.cancelTerminalCheckout({
    checkoutId: "checkout_id",
  })
})
```

## Inputs

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

| Field        | Type     | Required | Default | Description                                       |
| ------------ | -------- | -------- | ------- | ------------------------------------------------- |
| `checkoutId` | `string` | Yes      | —       | The unique ID for the desired `TerminalCheckout`. |

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

## Output

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