GET
/
api
/
subscription

Authorizations

​
x-api-token
string
headerrequired

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Response

200 - application/json

Response model for a successful Subscription request retrieving plan information.

Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null/undefined if the data couldn't be extracted during processing.
​
active
boolean
required

Indicates whether the subscription is currently active.

​
concurrent_calls
integer
required

The number of API calls allowed per second allowed in the current plan.

​
plan
string
required

The name of the subscription plan.

​
plan_calls
integer
required

The total number of API calls assigned to the current subscription.

​
remaining_calls
integer
required

The number of API calls remaining for the current subscription period.

​
historical_days
integer
required

The number of historical days accessible under the current subscription plan.

Was this page helpful?

Get aggregation count by intervalRetrieve subscription plan information