Update subscription plan

Updates mutable subscription plan fields and on-chain identifiers.

PATCH/v1/payments/subscription-plans/{planId}Run in dashboard

Requires an API key with the recurring.execute action.

Path parameters

  • planId · string · required · min length 1 · example psp_example

    SDP subscription plan record ID.

Headers

  • x-project-id · string · min length 1 · example prj_example

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

  • Idempotency-Key · string

    Use a unique 1–255 printable ASCII key per operation. Reuse it with the same request on retries. An in-flight attempt returns 409; a changed request returns 422. Retry and recovery rules.

Request body

application/json · required

Updates mutable SDP subscription plan fields.

  • planPda · string | null · example 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU

    On-chain plan PDA, or null to clear it.

  • destinationAddress · string | null

    Destination owner address, or null to clear it.

  • pullerWalletId · string | null · min length 1 · example wal_collector

    Collection wallet ID, or null to clear it.

  • metadataUri · string | null · format uri · max length 128

    Plan metadata URI, or null to clear it.

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

    Subscription plan status.

Responses

  • 200 Subscription plan updated

    • data · object · required

      Subscription plan response payload.

      • subscriptionPlan · object · required

        Recurring payment subscription plan record.

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

    • 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.execute 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.

  • 404 Not Found

    Same fields as 400.

  • 409 Conflict

    Same fields as 400.

  • 422 Unprocessable Entity

    Same fields as 400.

  • 500 Internal Server Error

    Same fields as 400.

Example request

IDEMPOTENCY_KEY=$(uuidgen)
curl -X PATCH 'https://api-beta.solana.com/v1/payments/subscription-plans/psp_example' \
  -H "Authorization: Bearer $SDP_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "planPda": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
    "pullerWalletId": "wal_collector",
    "status": "active"
  }'
// Reuse this key when you retry this request.
const idempotencyKey = crypto.randomUUID();
const res = await fetch("https://api-beta.solana.com/v1/payments/subscription-plans/psp_example", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.SDP_API_KEY}`,
    "Idempotency-Key": idempotencyKey,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "planPda": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
    "pullerWalletId": "wal_collector",
    "status": "active"
  })
});
import os, requests, uuid

# Reuse this key when you retry this request.
idempotency_key = str(uuid.uuid4())
r = requests.patch("https://api-beta.solana.com/v1/payments/subscription-plans/psp_example",
  headers={"Authorization": f"Bearer {os.environ['SDP_API_KEY']}", "Idempotency-Key": idempotency_key},
  json={
    "planPda": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
    "pullerWalletId": "wal_collector",
    "status": "active"
  })

Example responses

JSON
{
  "data": {
    "subscriptionPlan": {
      "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"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}
JSON
{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Missing action: recurring.execute",
    "details": {
      "action": "recurring.execute"
    }
  },
  "meta": {
    "requestId": "req_example"
  }
}

Error responses use the standard error shape.