Skip to main content
GET
Read the plan behind the key

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Response

Plan, credit and concurrency figures for the calling key.

status
string

The subscription's state, for example ACTIVE.

period_starts_at
string<date-time>
period_ends_at
string<date-time>

When the credit allowance renews.

usage
number

Spend this period, in US dollars.

usage_credits
integer

Credits used this period, across products.

credit_limit
integer

Credits the plan includes for the period.

usage_percent
integer

usage_credits as a whole percentage of credit_limit.

plan
object
top_ups
object[]

Credit top-ups bought this period.

api_key
object