> 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 recurring payments

Lists SDP-custody outbound recurring payments for the authenticated organization or project scope.

`GET /v1/payments/recurring-payments`

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

## Query parameters

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

  Filter recurring payments by counterparty.

- **`status`** · `string` · one of `pending_activation`, `activating`, `active`, `updating`, `canceling`, `resuming`, `paused`, `canceled`, `expired` · example `active`

  Recurring payment status.

- **`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`** Recurring payment list

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

    Recurring payment list response payload.

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

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

        SDP recurring payment ID.

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

        Organization identifier.

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

        Project identifier.

      - **`sourceCustodyWalletId`** · `string | null` · required · example `cwlt_example`

        Exact source SDP Wallet ID, or null for unresolved legacy records.

      - **`sourceProviderWalletId`** · `string` · required · min length 1 · example `privy_wallet_123`

        Source Provider wallet ID retained as evidence.

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

        Source wallet address.

      - **`counterpartyId`** · `string` · required · example `cpty_example`

        Counterparty ID.

      - **`counterpartyAccountId`** · `string` · required · example `cpacct_example`

        Counterparty account ID.

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

        Counterparty wallet owner address.

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

        Derived counterparty token account used for collection.

      - **`token`** · `string` · required

        SPL token mint address.

      - **`amount`** · `string` · required · example `100.00`

        Token amount in UI units (decimal string).

      - **`periodHours`** · `integer` · required · greater than 0 · example `720`

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

        Requested first collection timestamp.

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

        Next due collection timestamp.

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

        Linked SDP subscription plan ID.

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

        Linked SDP subscription ID.

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

        On-chain plan PDA.

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

        On-chain plan createdAt value as an unsigned integer string.

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

        Solana signature for plan creation.

      - **`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

        Solana signature for subscription authorization.

      - **`status`** · `string` · required · one of `pending_activation`, `activating`, `active`, `updating`, `canceling`, `resuming`, `paused`, `canceled`, `expired` · example `active`

        Recurring payment status.

      - **`pausedReason`** · `string | null` · required · one of `custody_policy_refused`, `failed_attempts` · example `null`

        Why SDP paused the recurring payment, set exactly while `status` is `paused`: `custody_policy_refused` when the custody provider's policy refused to sign a collection, `failed_attempts` when one due period failed 5 times. Resume clears it.

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

        Optional plan metadata URI.

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

        Creator user ID or API key ID.

      - **`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/recurring-payments' \
  -H "Authorization: Bearer $SDP_API_KEY"
```

```ts tab="TypeScript"
const res = await fetch("https://api.solana.com/v1/payments/recurring-payments", {
  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/recurring-payments",
  headers={"Authorization": f"Bearer {os.environ['SDP_API_KEY']}"})
```

## Example responses

```json tab="200"
{
  "data": {
    "recurringPayments": [
      {
        "id": "prp_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "sourceCustodyWalletId": "cwlt_example",
        "sourceProviderWalletId": "privy_wallet_123",
        "sourceAddress": "So11111111111111111111111111111111111111112",
        "counterpartyId": "cpty_example",
        "counterpartyAccountId": "cpacct_example",
        "destinationAddress": "So11111111111111111111111111111111111111112",
        "destinationTokenAccount": "So11111111111111111111111111111111111111112",
        "token": "example",
        "amount": "100.00",
        "periodHours": 720,
        "firstCollectionAt": "2025-01-01T00:00:00.000Z",
        "nextCollectionDueAt": "2025-01-01T00:00:00.000Z",
        "planId": "plan_example",
        "subscriptionId": "subscription_example",
        "planPda": "So11111111111111111111111111111111111111112",
        "planCreatedAt": "example",
        "planCreationSignature": "example",
        "subscriptionPda": "So11111111111111111111111111111111111111112",
        "subscriptionAuthorityAddress": "So11111111111111111111111111111111111111112",
        "authorizationSignature": "example",
        "status": "active",
        "pausedReason": null,
        "metadataUri": "example",
        "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).