latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

Update subscription plan

Updates mutable subscription plan fields and on-chain identifiers.

patch/v1/payments/subscription-plans/{planId}

Path parameters

planIdstring required

SDP subscription plan record ID.

Example:psp_example

SDP subscription plan record ID.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

planPdastring nullable

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

destinationAddressstring nullable

Destination owner address, or null to clear it.

pullerWalletIdstring nullable

Collection wallet ID, or null to clear it.

metadataUristring uri nullable

Plan metadata URI, or null to clear it.

status'draft' | 'active' | 'archived'

Subscription plan status.

Example request

{
  "planPda": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
  "pullerWalletId": "wal_collector",
  "status": "active"
}

Response

Subscription plan updated

Example response

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