Tools
get_account
Shows your plan, its state and dates, which gated reads it opens, and how much of each quota and limit is used and left in this cycle.
When to use it
- Before you tell someone which plan includes a reading, or whether they have quota left.
- You want the dates: when a trial ends, when the cycle renews, whether the plan cancels at its end, and whether it bills by the month or the year.
- For the items behind a count, use
list_views,list_watchlistorlist_destinations.
Inputs
None.
Examples
How many MCP requests do I have left this month?
{}Which plan am I on, and when does it renew?
{}What comes back
plan(Free,Pro,MaxorUltra) andtier, the plan the account works at.plan_state, the state of the plan:none,lapsed,trial,comp,org_seat(a seat on an organization's plan),pass,paid,paid_endingorpast_due.plan_source, how the account holds its plan:whop,trial,org_seat,compornone.trial_ends_at,current_period_endandcancel_at_period_end, andbilling_period,monthoryear, ornullwith no paid plan.usage, one entry per quota or limit, each withused,limit,leftandunlimited. When the plan sets no limit,leftisnullandunlimitedistrue. A quota the plan does not include is not listed.usage_period, the first and last day of the running cycle and the day it renews.capabilities, onetrueorfalseper gated read the plan opens, andsales_feed, whether the plan opens completed sales.allowancesandallowance_period, the older names ofusageandusage_period, still served. Each allowance also gives itslabelandkind:periodis a quota you spend over the cycle, like MCP requests or Screener runs;heldis a limit on what you hold now, like Views and stars or alert destinations.plans_url, the link to the plans page.
Limits and quota
- Reads only: it changes nothing.
- Free: it spends no quota.
- Shows the signed-in account only.