Payments

Get subscription plan

Retrieves a recurring-payment subscription plan record.

get/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.

Response

Subscription plan

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"
  }
}

Changes

Changed in 1 of the 10 revisions of this API.4

Aug 15, 20263e302bba53864See the full diff
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 403
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 500
  response-property-enum-value-added

Full history