> ## 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 Loyalty Promotion

> Cancels a loyalty promotion.

`square.cancelLoyaltyPromotion` cancels a loyalty promotion.

## Example

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

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

  square.cancelLoyaltyPromotion({
    programId: "program_id",
    promotionId: "promotion_id",
  })
})
```

## Inputs

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

| Field         | Type     | Required | Default | Description                                                                                                       |
| ------------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `programId`   | `string` | Yes      | —       | The ID of the base loyalty program.                                                                               |
| `promotionId` | `string` | Yes      | —       | The ID of the loyalty promotion to cancel. You can cancel a promotion that has an `ACTIVE` or `SCHEDULED` status. |

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

## Output

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