List Subscriptions

View as Markdown

Retrieve a paginated list of all subscriptions associated with your API profile, sorted by timestamp in descending order (most recent first).

Notes:

Returns up to 50 subscriptions per page.
Requires a valid API Key with access to the profile.
Results are automatically sorted by creation timestamp, with the newest subscriptions appearing first.
Use pagination parameters to navigate through multiple pages of results.

Method: GET

Path: https://api.blockbee.io/subscription/list/

Parameters

Query Parameters

`apikeystring`•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial.

Note: The API key can also be sent as a header named apikey.

Example:your_api_key_here

`pinteger`

Page number for pagination. Defaults to 1.

Example:1

Returns

Returns a paginated list of subscriptions.

`statusstring`

Status of the request.

`subscriptionsobject[]`

List of subscriptions tied to the API profile.

tokenstring

Token associated with the subscription.

urlstring

Subscription or payment link for the customer.

activeboolean

Indicates if the subscription is active.

user_idstring

User identifier in your system.

user_emailstring

Customer e-mail.

end_date_tsinteger

Timestamp of the subscription's expiration (may be null).

payment_listobject[]

List of completed payments for the subscription.

tokenstring

Token for the specific payment.

valuestring

The value of the payment.

coinstring

The cryptocurrency used for the payment.

duration_tsinteger

Duration in seconds.

received_fiatstring

FIAT amount received for the payment.

is_paidboolean

true if the payment is paid.

is_pendingboolean

true if the payment is pending blockchain confirmation.

is_partialboolean

true if the payment is partially paid.

`num_pagesinteger`

Total number of pages available.

Response

JSON

{
  "status": "success",
  "subscriptions": [
    {
      "token": "J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO",
      "url": "https://pay.blockbee.io/subscription/J78yEgW01HIOGZqBeqzxpXFuCwHGQgdO/",
      "active": true,
      "user_id": "user_example",
      "user_email": "[email protected]",
      "end_date_ts": 1753022709,
      "payment_list": [
        {
          "token": "Wd1lggEvyy1usHooflFiEGNQbBn4TNvJ",
          "value": "1.99",
          "coin": "usd",
          "duration_ts": 2592000,
          "received_fiat": "1.99",
          "is_paid": true,
          "is_pending": false,
          "is_partial": false
        }
      ]
    }
  ],
  "num_pages": 1
}