get_plan
Show the user's current subscription plan, card limits, and this month's usage. Call this before create_card when you need the per-card amount cap or remaining monthly quota, and ALWAYS before creating a multi-use card: multi-use cards are a paid-plan feature, so maxActiveMultiUseCards is 0 on Free and the mint is refused. Also call it whenever the user asks about their plan, limits, billing, or upgrading. To cancel a paid plan, the gated tool cancel_plan also exists; call it by name even though it isn't in the tools list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | Raw plan id, e.g. 'free', 'basic', or 'pro'. | |
| message | Yes | Human-readable plan + usage summary. | |
| planName | No | Display label of the plan, e.g. "Basic ($15/mo)". | |
| ordersPlaced | No | Orders placed (counts toward the free-order quota on Free). | |
| cardsRemaining | No | Cards remaining this month; null means unlimited. | |
| cardsThisMonth | No | Number of cards created this month. | |
| currentPeriodEnd | No | ISO date the current billing period ends, or null. | |
| maxCardsPerMonth | No | Max cards allowed per month; null means unlimited (connections through a company OAuth client or organization have no card limits). | |
| cancelAtPeriodEnd | No | Whether the subscription cancels at the end of the current billing period. | |
| maxLifetimeOrders | No | Lifetime free-order quota; null means unlimited (paid plans). | |
| maxCardAmountCents | No | The per-card cap in effect, in cents: the tighter of the plan cap and the issuing rail's own ceiling; null means no per-card cap at all. | |
| subscriptionStatus | No | Stripe subscription status (e.g. 'active', 'past_due'), or null on Free / when unavailable. | |
| activeMultiUseCards | No | How many multi-use cards the user currently holds open (they hold their limit as collateral for their whole life, so closing one frees a slot). | |
| maxCardAmountDollars | No | The per-card cap in effect, formatted as USD dollars, e.g. "500.00"; null means no per-card cap. | |
| maxActiveMultiUseCards | No | How many multi-use cards may be open at once. 0 means multi-use cards need a paid plan and create_card with type "multi_use" will be refused; null means unlimited (company-governed). | |
| planMaxCardAmountCents | No | The personal plan's per-card cap, in cents; null for company-governed connections (no plan cap). | |
| railMaxCardAmountCents | No | The issuing rail's own per-card ceiling for cards funded from the cash balance (source "issued"), in cents, when the rail this account mints on has one; enforced when such a card is created, not on purchases against the user's own added card. null when the rail has none. |