Check usage and credits
get_usageReturns the account's credits used, included and remaining, when they reset, the plan, a billing link, and the daily reading allowance that saved and tracked-ad reads draw on. For checking the balance before paid work, or after a read reports that the allowance is used up.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_usage"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brand_id | No | Optional brand id from list_brands: reports the reading allowance of that brand's workspace. Defaults to the current workspace. | |
| response_format | No | Output format: text (default) or json. table is not available for this tool. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile | No | profile value in this response. | |
| allowance | No | Free daily ad-return allowance for this workspace, resetting at midnight UTC. | |
| resets_at | No | ISO timestamp when the allowance or credits reset. | |
| billing_url | No | billing url value in this response. | |
| reset_at_ms | No | reset at ms value in this response. | |
| credits_used | No | credits used value in this response. | |
| balance_credits | No | balance credits value in this response. | |
| included_credits | No | included credits value in this response. | |
| credits_remaining | No | credits remaining value in this response. | |
| reading_allowance | No | Free daily ad-return allowance for this workspace, resetting at midnight UTC. | |
| monthly_generation_count | No | monthly generation count value in this response. |