preview_plan_change
Shows what a plan change would cost without changing anything.
Preview plan change · Read-only
Shows what a plan change would cost without changing anything. Returns direction (upgrade, downgrade or flat), intervalChanged, current and new leads, newMonthlyCents, chargedNowCents (amount charged today, in cents), nextInvoiceCents and nextInvoiceDate. For a same-interval upgrade, today's charge is the extra leads at the new plan's per-lead price (newPerLeadCents), not a time-based proration. chargedNowCents is 0 for downgrades and for monthly/yearly switches. Always run this before upgrade_plan and show the user the price. Fails if the account has no active paid subscription.
| Connection | Account-owner URL or OAuth (not a team member URL) |
|---|
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
leads | number | Yes | Leads per month of the new plan, e.g. 1000, 3000, 5000. |
annual | boolean | No | true for yearly billing, false for monthly. Leave it out to keep the current billing interval; only pass a value when the user wants to switch. |
Tool definition
What your assistant receives from tools/list:
{
"name": "preview_plan_change",
"title": "Preview plan change",
"annotations": {
"title": "Preview plan change",
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"inputSchema": {
"type": "object",
"properties": {
"leads": {
"type": "number",
"description": "Leads per month of the new plan, e.g. 1000, 3000, 5000."
},
"annual": {
"type": "boolean",
"description": "true for yearly billing, false for monthly. Leave it out to keep the current billing interval; only pass a value when the user wants to switch."
}
},
"required": [
"leads"
]
}
}get_subscription
Shows the current subscription: plan, tierName, leads per month, usedCredits, remaining, topUpCredits, refreshOn, price (monthly equivalent, USD), annualTotal, interval ('month' or 'year'), nextBillingDate, cancelAtPeriodEnd, subscriptionStatus, isPausedByUser/pausedUntil, pendingDowngrade, retentionDiscount and add-ons.
upgrade_plan
Moves the subscription to more leads per month right away and charges the card on file today.