> Solana Developer Platform docs, served as Markdown. The [docs index](https://platform.solana.com/docs.md) lists every page and [llms.txt](https://platform.solana.com/docs/ai/llms.txt) the key ones; [SKILL.md](https://platform.solana.com/SKILL.md) has the rules for building on SDP.

# List subscriptions

Lists recurring-payment subscriptions.

`GET /v1/payments/subscriptions`

Requires an [API key](/docs/developing-with-sdp/authentication) with the `recurring.read` action.

## Query parameters

- **`planId`** · `string` · min length 1

- **`counterpartyId`** · `string` · min length 1

- **`status`** · `string` · one of `pending_authorization`, `active`, `paused`, `canceling`, `canceled`, `expired` · example `active`

  Subscription status.

- **`dueBefore`** · `string` · format `date-time`

- **`page`** · `integer` · greater than 0 · default `1`

- **`pageSize`** · `integer` · min 1 · max 100 · default `20`

## Headers

- **`x-project-id`** · `string` · min length 1 · example `prj_example`

  Required for dashboard sessions. API keys use their assigned project.

## Responses

- **`200`** Subscription list

  - **`data`** · `object` · required

    Subscription list response payload.

    - **`subscriptions`** · `object[]` · required

      - **`id`** · `string` · required · example `psub_example`

        SDP subscription ID.

      - **`organizationId`** · `string` · required · min length 1 · example `org_example`

        Organization identifier.

      - **`projectId`** · `string` · required · min length 1 · example `prj_example`

        Project identifier.

      - **`planId`** · `string` · required

        SDP subscription plan ID.

      - **`counterpartyId`** · `string` · required

        Counterparty ID.

      - **`subscriberAddress`** · `string` · required · min length 32 · max length 44 · example `So11111111111111111111111111111111111111112`

        Base58-encoded Solana address.

      - **`subscriberTokenAccount`** · `string | null` · required · min length 32 · max length 44 · example `So11111111111111111111111111111111111111112`

        Subscriber token account address.

      - **`subscriptionPda`** · `string | null` · required · min length 32 · max length 44 · example `So11111111111111111111111111111111111111112`

        On-chain subscription PDA.

      - **`subscriptionAuthorityAddress`** · `string | null` · required · min length 32 · max length 44 · example `So11111111111111111111111111111111111111112`

        On-chain subscription authority address.

      - **`authorizationSignature`** · `string | null` · required

        Customer authorization transaction signature.

      - **`status`** · `string` · required · one of `pending_authorization`, `active`, `paused`, `canceling`, `canceled`, `expired` · example `active`

        Subscription status.

      - **`currentPeriodStartAt`** · `string | null` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

        ISO 8601 timestamp.

      - **`nextCollectionDueAt`** · `string | null` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

        ISO 8601 timestamp.

      - **`cancelAt`** · `string | null` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

        ISO 8601 timestamp.

      - **`canceledAt`** · `string | null` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

        ISO 8601 timestamp.

      - **`createdBy`** · `string | null` · required

      - **`createdAt`** · `string` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

        ISO 8601 timestamp.

      - **`updatedAt`** · `string` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

        ISO 8601 timestamp.

    - **`total`** · `integer` · required

    - **`page`** · `integer` · required

    - **`pageSize`** · `integer` · required

  - **`meta`** · `object` · required

    Response metadata.

    - **`requestId`** · `string` · required · min length 1 · example `req_example`

      Request identifier for tracing.

    - **`timestamp`** · `string` · required · format `date-time` · example `2025-01-01T00:00:00.000Z`

      ISO 8601 timestamp.

- **`400`** Bad Request

  - **`error`** · `object` · required

    Standard error payload.

    - **`code`** · `string` · required

      Machine-readable error code.

    - **`message`** · `string` · required

      Human-readable error message.

    - **`details`** · `object`

      Optional error details for debugging.

      - **`*`** · `any`

  - **`meta`** · `object`

    - **`requestId`** · `string` · min length 1 · example `req_example`

      Request identifier for tracing.

- **`401`** Unauthorized

  Same fields as `400`.

- **`403`** Forbidden. Requires the `recurring.read` action: an API key must hold it (a module's `manage` or `execute` also covers its `read`), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and `error.details.action` names the action. Any other 403 names its own reason.

  Same fields as `400`.

- **`500`** Internal Server Error

  Same fields as `400`.

## Example request

```bash tab="cURL"
curl 'https://api.solana.com/v1/payments/subscriptions' \
  -H "Authorization: Bearer $SDP_API_KEY"
```

```ts tab="TypeScript"
const res = await fetch("https://api.solana.com/v1/payments/subscriptions", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SDP_API_KEY}`
  }
});
```

```python tab="Python"
import os, requests

r = requests.get("https://api.solana.com/v1/payments/subscriptions",
  headers={"Authorization": f"Bearer {os.environ['SDP_API_KEY']}"})
```

## Example responses

```json tab="200"
{
  "data": {
    "subscriptions": [
      {
        "id": "psub_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "planId": "plan_example",
        "counterpartyId": "counterparty_example",
        "subscriberAddress": "So11111111111111111111111111111111111111112",
        "subscriberTokenAccount": "So11111111111111111111111111111111111111112",
        "subscriptionPda": "So11111111111111111111111111111111111111112",
        "subscriptionAuthorityAddress": "So11111111111111111111111111111111111111112",
        "authorizationSignature": "example",
        "status": "active",
        "currentPeriodStartAt": "2025-01-01T00:00:00.000Z",
        "nextCollectionDueAt": "2025-01-01T00:00:00.000Z",
        "cancelAt": "2025-01-01T00:00:00.000Z",
        "canceledAt": "2025-01-01T00:00:00.000Z",
        "createdBy": "example",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}
```

```json tab="403"
{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Missing action: recurring.read",
    "details": {
      "action": "recurring.read"
    }
  },
  "meta": {
    "requestId": "req_example"
  }
}
```

Error responses use the [standard error shape](/docs/reference/conventions/errors).