SOsolana
Payments

List subscriptions

Changed on

Lists recurring-payment subscriptions.

get/v1/payments/subscriptions

Request

  • Base URL
    http://localhost:8787
  • URL
    http://localhost:8787/v1/payments/subscriptions
  • Auth
    HTTP bearer

Query parameters

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

Subscription status.

Example:active
dueBeforestring date-time
pageinteger
pageSizeinteger

Headers

x-project-idstring

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

Example:prj_example

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

Changes

  • 9f0b1d561064Revision changes
    • warning

      added the new CUSTODY_POLICY_REFUSED enum value to the / response property for the response status

    • warning

      added the new CUSTODY_POLICY_REFUSED enum value to the / response property for the response status

    • warning

      added the new CUSTODY_POLICY_REFUSED enum value to the / response property for the response status

    • warning

      added the new CUSTODY_POLICY_REFUSED enum value to the / response property for the response status

  • f4a0135eca08Revision changes
    • warning

      added the new RPC_UNAVAILABLE enum value to the / response property for the response status

    • warning

      added the new RPC_UNAVAILABLE enum value to the / response property for the response status

    • warning

      added the new RPC_UNAVAILABLE enum value to the / response property for the response status

    • warning

      added the new RPC_UNAVAILABLE enum value to the / response property for the response status

    • warning

      added the new SPONSORED_RENT_OVER_CAP enum value to the / response property for the response status

    • warning

      added the new SPONSORED_RENT_OVER_CAP enum value to the / response property for the response status

    • warning

      added the new SPONSORED_RENT_OVER_CAP enum value to the / response property for the response status

    • warning

      added the new SPONSORED_RENT_OVER_CAP enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_DESTINATION_CHANGED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_DESTINATION_CHANGED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_DESTINATION_CHANGED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_DESTINATION_CHANGED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_NOTHING_TO_RETRY enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_NOTHING_TO_RETRY enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_NOTHING_TO_RETRY enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_NOTHING_TO_RETRY enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RETRY_CLAIMED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RETRY_CLAIMED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RETRY_CLAIMED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RETRY_CLAIMED enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RUN_EXISTS enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RUN_EXISTS enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RUN_EXISTS enum value to the / response property for the response status

    • warning

      added the new TRANSFER_BATCH_RUN_EXISTS enum value to the / response property for the response status