List subscription plans

Lists recurring-payment subscription plans.

GET/v1/payments/subscription-plansRun in dashboard

Requires an API key with the recurring.read action.

Query parameters

  • status · string · one of draft, active, archived · example active

    Subscription plan 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 Subscription plan list

    • data · object · required

      Subscription plan list response payload.

      • subscriptionPlans · object[] · required

        • id · string · required · example psp_example

          SDP subscription plan ID.

        • organizationId · string · required · min length 1 · example org_example

          Organization identifier.

        • projectId · string · required · min length 1 · example prj_example

          Project identifier.

        • ownerWalletId · string · required · min length 1 · example privy_wallet_123

          Provider wallet ID — the walletId field returned by GET /v1/wallets.

        • ownerAddress · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

          Base58-encoded Solana address.

        • token · string · required

          Token mint or normalized token identifier.

        • amount · string · required · example 100.00

          Token amount in UI units (decimal string).

        • periodHours · integer · required · greater than 0 · example 720

        • programPlanId · string · required · example 17014118346046923173

          Unsigned 64-bit decimal program plan identifier used in PDA derivation.

        • planPda · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

          On-chain plan PDA.

        • destinationAddress · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

          Allowed destination owner address.

        • pullerWalletId · string | null · required · min length 1 · example privy_wallet_123

          Collector wallet ID.

        • pullerAddress · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

          Collector wallet address.

        • metadataUri · string | null · required

          Optional plan metadata URI.

        • status · string · required · one of draft, active, archived · example active

          Subscription plan status.

        • 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

curl 'https://api.solana.com/v1/payments/subscription-plans' \
  -H "Authorization: Bearer $SDP_API_KEY"

Example responses

{
  "data": {
    "subscriptionPlans": [
      {
        "id": "psp_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "ownerWalletId": "privy_wallet_123",
        "ownerAddress": "So11111111111111111111111111111111111111112",
        "token": "example",
        "amount": "100.00",
        "periodHours": 720,
        "programPlanId": "17014118346046923173",
        "planPda": "So11111111111111111111111111111111111111112",
        "destinationAddress": "So11111111111111111111111111111111111111112",
        "pullerWalletId": "privy_wallet_123",
        "pullerAddress": "So11111111111111111111111111111111111111112",
        "metadataUri": "example",
        "status": "active",
        "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"
  }
}

Error responses use the standard error shape.

Is this page helpful?