TickerDocs
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_watchlist or list_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, Max or Ultra) and tier, 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_ending or past_due. plan_source, how the account holds its plan: whop, trial, org_seat, comp or none.
  • trial_ends_at, current_period_end and cancel_at_period_end, and billing_period, month or year, or null with no paid plan.
  • usage, one entry per quota or limit, each with used, limit, left and unlimited. When the plan sets no limit, left is null and unlimited is true. 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, one true or false per gated read the plan opens, and sales_feed, whether the plan opens completed sales.
  • allowances and allowance_period, the older names of usage and usage_period, still served. Each allowance also gives its label and kind: period is a quota you spend over the cycle, like MCP requests or Screener runs; held is 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.

On this page