Show plan and quota, or upgrade
upgradeCheck current plan, remaining quota, and benefits of higher tiers. Start a free trial or open checkout to upgrade when you need more capacity.
Instructions
Show the account's current plan, how much of each quota remains, and what a higher plan unlocks.
Called with no arguments it only reads — useful any time, not just after hitting a limit, and the natural follow-up when a write tool reports a quota error. Two arguments make it act rather than report, so pass them only on explicit instruction from the user: start_trial ENROLS the account in the free trial immediately (a real account change, not a preview), and open LAUNCHES a checkout page in the user's browser. Neither charges a card by itself.
Requires an API key. No billing state changes unless you pass start_trial; the returned quota snapshot already reflects a trial started in the same call. For whether you are authenticated at all, use status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| open | No | Open the checkout page in the user's default browser. Side effect on their desktop — only when they asked to upgrade. | |
| plan | No | Plan slug to open, e.g. 'pro' or 'business'. Defaults to the recommended plan. Only meaningful with open=true. | |
| start_trial | No | Enrol in the free no-card trial now, if eligible. This changes the account's plan — do not set it speculatively. |