account_retrieve
Retrieve your current credit balance and subscription details to manage API usage and billing.
Instructions
Get the current credit balance and subscription details of the account that owns the API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique ID of the account that owns the API key. | |
| tier | Yes | Subscription tier in effect for the account. `free` if there is no active subscription, including while a subscription is `past_due`. | |
| Yes | Email address of the account. | ||
| credits | Yes | Credits currently available to spend. Includes subscription credits and any purchased credit packs. | |
| subscription | Yes | 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. |