Skip to main content
GET
Get account details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Response

200

id
string
required

Unique ID of the account that owns the API key.

Example:

"cuid-example"

email
string | null
required

Email address of the account.

Example:

"user@example.com"

tier
enum<string>
required

Subscription tier in effect for the account. free if there is no active subscription, including while a subscription is past_due.

Available options:
free,
creator,
pro,
business
Example:

"pro"

credits
integer
required

Credits currently available to spend. Includes subscription credits and any purchased credit packs.

Required range: x >= 0
Example:

12500

subscription
object | null
required

Details of the account's subscription plan. null if the account has no subscription, e.g. a free account, an account that only purchased credit packs, or an account on usage-based API pricing.

Reflects the plan currently configured on the subscription. If a plan change is scheduled, tier stays on the current plan until the next payment succeeds, so tier and name can briefly disagree.