get_subscription
Retrieves current subscription details, including plan, status, billing period, and usage limits, to help you review entitlements and monitor usage. Requires a Proof account and PROOF_API_KEY.
Instructions
Get the current subscription details including plan, status, billing period, and usage limits.
ACCESS: needs a Proof account. Set PROOF_API_KEY and restart this server, then call this tool again. start_login does NOT open this tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | Yes | Plan to check out. `free` adds a card for pay as you go (the metered price past the included proofs); it is offered once billing is live. | |
| status | Yes | Stripe's status for the subscription, whatever it is (the caller decides what counts as subscribed); null when the account has no subscription. | |
| scheduled_plan | No | The plan a scheduled downgrade moves the account to at `scheduled_change_at`; null when nothing is scheduled. Absent from an API that predates plan changes. | |
| current_period_end | Yes | End of the current billing period; null without a subscription. | |
| scheduled_change_at | No | When the scheduled downgrade takes effect (the end of the paid period); null when nothing is scheduled. | |
| cancel_at_period_end | Yes | Whether the subscription ends at the end of the current period; false without a subscription. | |
| current_period_start | Yes | Start of the current billing period; null without a subscription. |