latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

List subscription plans

Lists recurring-payment subscription plans.

get/v1/payments/subscription-plans

Query parameters

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

Subscription plan status.

Example:active

Subscription plan status.

pageinteger

pageSizeinteger

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 list

Example response

{
  "data": {
    "subscriptionPlans": [
      {
        "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"
  }
}