Version
DESTRUCTIVE

update_copilot_credits_settings

Change the creator's Copilot Credits settings — the pack the auto top-up buys and under which balance, and the monthly cap on paid credit. Anything omitted keeps its stored value.

Change how the pool refills and how far it may be drawn: auto_topup_pack names the pack bought when the balance falls under auto_topup_below_cents, and monthly_spend_cap_cents is the paid credit the Copilot may draw in a calendar month before it stops. Partial by design: only the arguments present change, so auto_topup_pack: null switches the auto top-up off and touches nothing else. The bounds are the Billing dialog's, in cents: a threshold of $1 to $100 and a cap of $0 to $10,000. Saving the settings resumes an auto top-up a failed charge had paused.

The free allowance is never capped, and the cap never stops a turn the allowance covers.

Switching the auto top-up on needs a card on file. The first pack bought on the Checkout page saves one; without it the tool refuses with VALIDATION_FAILED and the stored settings stand.

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

DestructiveIdempotent

A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.

Arguments

auto_topup_packstring | nulloptional

The pack the auto top-up buys: "starter", "regular", "plus" or "max"; null switches the auto top-up off.

auto_topup_below_centsintegeroptional

The balance in US cents under which the auto top-up buys (100..10000).

min100max10000
monthly_spend_cap_centsintegeroptional

The paid credit in US cents the Copilot may draw in a calendar month (0..1000000).

min0max1000000

What it returns

{  "data": {    "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-20T08:15:00+00:00"  }}

The same settings object get_copilot_credits returns, after the change.

How it fails

VALIDATION_FAILED

auto_topup_pack is not a pack on sale, auto_topup_below_cents is outside 100 to 10,000, monthly_spend_cap_cents is outside 0 to 1,000,000, or the auto top-up is switched on with no card on file. The envelope names the offending field.

AUTHENTICATION_REQUIRED

no authenticated user on the request.

TOKEN_MISSING_ABILITY

token lacks account:write.

How is this guide?

Last updated on