Your plan, caps and usage
get_planWhat this token is allowed to do right now, and what it costs.
Call it when another tool refuses, when you want to know how long a trial has left, or before telling a person they need to pay. It takes no arguments — it describes the token you are already authenticated with.
Returns the plan, its state (trial / active / expired), the flat monthly
price, whether saved searches are currently matching, the subscribe and
cancel links, and usage — today's call count against the daily cap, today's
distinct corpus questions against theirs, and when both reset. Read usage
before a long paging walk: every page is one call.
trial_ends_at is a date only while the state IS trial, and null
otherwise. A paid plan keeps the date internally so that cancelling inside
the original window falls back to the trial, but showing it on an active
subscription made the plan look like it was expiring.
Readable on every plan state including expired, deliberately: someone deciding whether to pay has to be able to see what they had.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | The plan on this account. | |
| label | No | The token's label, which carries the source it was minted from. Null for a token minted by hand before self-serve. A null label means the source is unknown, not that the signup was direct. | |
| state | No | trial | active | expired. This is what the corpus tools gate on. | |
| usage | No | Today's counters. NULL when they could not be read — never zeros, which a caller would budget against. | |
| billing | No | How billing works, in one sentence. | |
| subscribe | No | Where to start paying, when a link is configured. | |
| trial_ends_at | No | ISO 8601 while the state IS trial, and null otherwise. A paid plan keeps the date internally but does not report it. | |
| saved_searches | No | Whether saved searches are currently matching or paused. | |
| price_usd_month | No | The flat monthly price. No credits and no per-call fee. | |
| manage_or_cancel | No | Where to change or cancel the subscription. |