Read my usage and limits
get_usageGet the user's own use of their plan: for each limited action, how many uses the current period counted, the allowance, and how many are available now; when a calendar period (day, month) resets, and for rolling windows (week, 30 days) when the oldest use drops out; bonus and pack credits, which buy uses beyond an allowance; and when a paid plan or trial ends. A resume generated in the background from text or answers (create_profile, the web onboarding) counts against resume_generation. Radar scans are not bought with bonus or pack credits. The actions listed are the same ones get_pricing gives limits for. Plan prices and the limits of other plans are in get_pricing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | The user's current tier: 'free' | 'sprint' | 'career'. | |
| items | Yes | One row per action the plan limits. | |
| credits | Yes | Bonus and pack credits, which buy uses beyond an action's allowance on any plan; null when there are none. | |
| plan_ends_at | Yes | ISO 8601 UTC moment the paid plan or trial ends and the account returns to free; null on free. Whether a plan renews is the auto_renews of its SKU in get_pricing. |