get_plan
Get the current account's plan and usage telemetry. Returns the AUTHORITATIVE plan limits AND real-time usage so you can warn the user when they are approaching a cap. Key fields: plan.Name (plan name to mention to the user), plan.Settings.MaxSweepstakesAllowed (single cap on TOTAL sweepstakes — there is NO separate active vs total limit, the API treats them as one count), plan.Settings.MaxParticipantsAllowed, plan.Settings.MaxStorageSize (GB), plan.Settings.MaxApiCallsAllowed, plan.Settings.SubscriptionPrice; telemetry.DataConsumed (GB used now), telemetry.APICalls (calls used this period). Each account can have a custom plan — these values OVERRIDE any default numbers mentioned in other tool descriptions or instructions. Call this once per session before creating/cloning sweepstakes, before quoting limits or usage to the user, or when the user asks about pricing, billing, or feature availability.
get_plan
When to call
BEFORE: creating/cloning a sweepstakes, quoting limits or usage to the user, suggesting an upgrade, or answering questions about pricing, billing, or which features are enabled.
ONCE per session — cache the result mentally; the response rarely changes mid-session.
Why authoritative
plan.Settings.MaxSweepstakesAllowed is a SINGLE per-account cap. The API does NOT distinguish "active" from "total" — there is only one count.
Different accounts can have very different plans (admin, enterprise, default). Always trust the values returned by this tool over any number mentioned elsewhere in tool descriptions or instructions.
Reading the response
plan.Name— say this name to the user when discussing limits (e.g. "your plan 'X' allows...")plan.Settings.MaxSweepstakesAllowed— total sweepstakes capplan.Settings.MaxParticipantsAllowed— total participants in the accountplan.Settings.MaxStorageSize— GBplan.Settings.MaxApiCallsAllowed— API call quotaplan.Settings.PaidModule*(15 booleans) — which features are enabled vs gatedtelemetry.DataConsumed— GB used now (compare against MaxStorageSize)telemetry.APICalls— calls used this period (compare against MaxApiCallsAllowed)
If usage is >= 80% of any cap, warn the user proactively.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||