GET/api/integrations/billing/subscription

Get the current subscription

Retrieves the current subscription details for the account. Use this endpoint to review the subscription's plan tier, price, provider, status, and any included features.

4 status codes
200Returns the subscription's active status, plan tier, price and currency, provider, price identifier, last-updated timestamp, and any included features or remaining trial time.
activebooleanrequired
Indicates whether the subscription is active or not.
currencystringrequired
Currency code of the subscription.
featuresarray<string>optional
List of features included in the subscription.
plan_tierstringrequired
The tier of the plan for the subscription.
priceintegerrequired
Price amount in minor units (e.g., cents).
price_idstringrequired
Unique identifier for the price of the subscription.
providerstringrequired
The provider of the subscription.
remaining_trialintegeroptional
The remaining time for the trial period, in seconds.
updated_atstringrequired
The date and time when the subscription was last updated.
401Returned when the request lacks valid authentication.
404Returned when no subscription is found.
500Returned when an internal server error occurs.

Error handling

A 401 is returned when the request lacks valid authentication. A 404 indicates that no subscription was found for the account, and a 500 indicates an internal server error.