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

# List Subscription Events

> Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.

`square.listSubscriptionEvents` lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a specific subscription.

## Example

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

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

  square.listSubscriptionEvents({
    subscriptionId: "subscription_id",
    cursor: "cursor",
    limit: 1,
  })
})
```

## Inputs

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

| Field            | Type             | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                                     |
| ---------------- | ---------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `subscriptionId` | `string`         | Yes      | —       | The ID of the subscription to retrieve the events for.                                                                                                                                                                                                                                                                                                                                          |
| `cursor`         | `string \| null` | No       | —       | When the total number of resulting subscription events exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). |
| `limit`          | `number \| null` | No       | —       | The upper limit on the number of subscription events to return in a paged response.                                                                                                                                                                                                                                                                                                             |

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

## Output

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