get_copilot_credits
Read the creator's Copilot Credits in one object — the balance split into free and paid, this month's allowance and usage, the prices, the packs on sale and the settings.
Read everything about the pool that pays for Subscriby Copilot: the balance with its free and paid parts and what lapses next, this month's free allowance of operator turns and member answers with what is used and left, this month's usage per kind, the per-unit prices, the packs on sale in this environment and the settings for the auto top-up and the monthly cap. The token says whose credits they are, so the tool takes no input; it renders the same object as GET /v1/me/copilot-credits, so an agent and the Billing page never disagree about the figures.
An agent asking "can I afford another turn" needs only this: the allowance comes first, then the free part of the pool, then the paid part, and exhausted says when the pool is empty while the allowance may still cover a turn.
Read-only. Never mutates anything.
Copilot Credits are the creator's own. A team member who presses Ask Copilot spends the owner's pool, and a token minted by a team member reads the owner's figures here.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
This tool takes no arguments.
What it returns
{ "data": { "balance": { "total_cents": 3250, "free_cents": 750, "paid_cents": 2500, "lapsing_cents": 500, "lapsing_at": "2027-01-16T00:00:00+00:00", "exhausted": false }, "allowance": { "period_start": "2026-10-01", "turns_used": 12, "turns_limit": 25, "turns_left": 13, "answers_used": 40, "answers_limit": 250, "answers_left": 210 }, "turns_this_month": 12, "suggestions_this_month": 4, "answers_this_month": 40, "paid_spent_this_month_cents": 0, "price_turn_cents": 10, "price_suggestion_cents": 5, "price_answer_cents": 1, "long_turn_steps": 4, "max_turn_steps": 8, "low_balance_cents": 500, "packs": [ { "pack": "starter", "label": "Starter Pack", "paid_cents": 1000, "bonus_cents": 0, "total_cents": 1000 }, { "pack": "regular", "label": "Regular Pack", "paid_cents": 2500, "bonus_cents": 250, "total_cents": 2750 } ], "settings": { "auto_topup_pack": "regular", "auto_topup_pack_label": "Regular Pack", "auto_topup_below_cents": 500, "monthly_spend_cap_cents": 2000, "auto_topup_paused_at": null, "updated_at": "2026-10-12T09:20:00+00:00" } }}Every amount is an integer in US cents. paid_spent_this_month_cents is the figure settings.monthly_spend_cap_cents is measured against; suggestions_this_month has no allowance behind it, because an inbox suggestion always draws from the pool.
How it fails
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks account:read.
Related
How is this guide?
Last updated on
get_account_export
Read the creator's most recent account export — its status, timing, size and project count, and the signed download link while it is ready. The same payload as GET /v1/me/export. Takes no input.
get_me
Describe the creator the token belongs to — plan and capabilities, the team the token is scoped to, every team held, connected accounts and alert destinations. Takes no input.