Fetch Subscription

View as Markdown

Retrieve the details of a specific subscription using its token.

Notes:

  • Requires a valid API Key with access to the profile.
  • The token must match a subscription created under your profile.

Method: GET

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

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.

tokenstring•Required

Unique subscription token.

Example:I55hhRINHptLJPwsqwYNxJOKBItRiq1o

Returns

Returns the details of the specified subscription.

statusstring

Status of the request.

subscriptionobject

Contains detailed information about the subscription.

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.