Check Credits
check_creditsRead the selected workspace's credit balance, action prices, free Brand creations, and payment status. This check does not spend credits or change the subscription.
Brand creation, Brand edits, Briefs, and Reviews spend credits when credit_costs lists a nonzero price for them. Prices vary by workspace, so use this workspace's credit_costs when quoting them. free_brand_creations counts Brand creations that won't spend credits. Selected-model AI Gateway image, video, audio, and SVG pricing depends on the model and request; neither the balance nor credit_costs establishes that price or the model's availability.
subscription_paused is present (true) when a past_due plan actually blocks access — the last payment failed, so plan credits are on hold until payment is completed. Credits remain spendable.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspace_id": "<workspace_id>"
},
"name": "check_credits"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| llm_model | No | The model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics. | |
| workspace_id | Yes | Workspace whose balance and action prices to read. Use its ID from list_workspaces; call list_workspaces first if the intended workspace has not been identified. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| balance | Yes | Remaining workspace credits. Read unlimited and subscription_paused alongside this value; balance alone does not establish whether an operation can run. | |
| unlimited | Yes | Whether the workspace has unlimited credits. This does not establish selected-model generation pricing or availability. | |
| credit_costs | Yes | Credits each action costs this workspace. 0 means the action is free right now. Selected-model generations are priced per request and aren't listed. | |
| workspace_id | Yes | Workspace ID that was checked. | |
| workspace_name | Yes | Workspace name. | |
| pricing_version | Yes | The workspace's pricing version. Credit amounts are comparable only within one version. | |
| subscription_paused | No | Present only when a failed payment blocks plan access. It can appear even when top-up credits leave the balance positive. | |
| free_brand_creations | Yes | Brand creations the workspace can still make without spending credits | |
| message_for_assistant | No | Context, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim. |