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

# Retrieve Subscription

> Retrieves a specific subscription.

`square.retrieveSubscription` retrieves a specific subscription.

## Example

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

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

  square.retrieveSubscription({
    subscriptionId: "subscription_id",
    include: "include",
  })
})
```

## 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.                                                                                                                                                            |
| `include`        | `string \| null` | No       | —       | A query parameter to specify related information to be included in the response. The supported query parameter values are: - `actions`: to include scheduled actions on the targeted subscription. |

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

## Output

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