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

# Search Subscriptions

> Searches for subscriptions.

`square.searchSubscriptions` searches for subscriptions.

## Example

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

export default automation("Search Square Subscriptions", () => {
  onDashboardRun({ title: "Search Square Subscriptions" })

  square.searchSubscriptions({
    query: {
      filter: {
        customerIds: ["CHFGVKYY8RSV93M5KCYTG4PN0G"],
        locationIds: ["S8GWD5R9QB376"],
        sourceNames: ["My App"],
      },
    },
  })
})
```

## Inputs

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

| Field     | Type                              | Required | Default | Description                                                                                                                                                                                                                                                                                                                                                                               |
| --------- | --------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor`  | `string`                          | No       | —       | When the total number of resulting subscriptions 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`                          | No       | —       | The upper limit on the number of subscriptions to return in a paged response.                                                                                                                                                                                                                                                                                                             |
| `query`   | `Square.SearchSubscriptionsQuery` | No       | —       | A subscription query consisting of specified filtering conditions. If this `query` field is unspecified, the `SearchSubscriptions` call will return all subscriptions.                                                                                                                                                                                                                    |
| `include` | `string[]`                        | No       | —       | An option to include related information in the response. The supported values are: - `actions`: to include scheduled actions on the targeted subscriptions.                                                                                                                                                                                                                              |

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

## Output

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