Sign in
latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

List subscriptions

Lists recurring-payment subscriptions.

get/v1/payments/subscriptions

Query parameters

planIdstring
counterpartyIdstring
status'pending_authorization' | 'active' | 'paused' | 'canceling' | 'canceled' | 'expired'

Subscription status.

Example:active

Subscription status.

dueBeforestring date-time
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 list

Example response

{
  "data": {
    "subscriptions": [
      {
        "id": "psub_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "subscriberAddress": "So11111111111111111111111111111111111111112",
        "subscriberTokenAccount": "So11111111111111111111111111111111111111112",
        "subscriptionPda": "So11111111111111111111111111111111111111112",
        "subscriptionAuthorityAddress": "So11111111111111111111111111111111111111112",
        "status": "active",
        "currentPeriodStartAt": "2025-01-01T00:00:00.000Z",
        "nextCollectionDueAt": "2025-01-01T00:00:00.000Z",
        "cancelAt": "2025-01-01T00:00:00.000Z",
        "canceledAt": "2025-01-01T00:00:00.000Z",
        "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"
  }
}