# List Subscriptions — Polar

> List subscriptions according to the specified filters. See the API docs

- Key: `polar-list-subscriptions`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Polar (`polar`) — https://pipedream.com/apps/polar.md
- This page (HTML): https://pipedream.com/apps/polar/actions/list-subscriptions
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/polar/actions/list-subscriptions/list-subscriptions.mjs

## Description

List subscriptions according to the specified filters. [See the API docs](https://polar.sh/docs/api-reference/subscriptions/list)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `organizationId` | `string` | No | Filter by organization ID (UUID). Optional — omit to return results across all organizations. Find it in Settings → General under Identifier. |
| `productId` | `string` | No | Select a product or provide a custom Product ID (UUID). Search by product name or Product ID (UUID). Options are loaded from the connected account. |
| `customerId` | `string` | No | Select a customer or provide a custom Customer ID (UUID). Search by name, email, or Customer ID (UUID). Options are loaded from the connected account. |
| `active` | `boolean` | No | Filter by active or inactive subscription |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "polar",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "polar-list-subscriptions",
  arguments: {
    organizationId: "Organization ID",
    productId: "Product",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "polar-list-subscriptions",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    polar: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization ID",
    productId: "Product",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "polar-list-subscriptions",
    "configured_props": {
      "polar": { "authProvisionId": "apn_xxxxxxx" },
      "organizationId": "Organization ID",
      "productId": "Product"
    }
  }'
```

---

- App: https://pipedream.com/apps/polar.md · All apps: https://pipedream.com/apps