upgrade_plan
Moves the subscription to more leads per month right away and charges the card on file today.
Upgrade plan · Changes data · Acts outside your account · Spends credits or money
Moves the subscription to more leads per month right away and charges the card on file today. Same interval: the charge is the extra leads at the new plan's per-lead price, the extra credits are added now and the renewal date stays the same. Switching monthly/yearly: the current subscription is replaced and the full new amount is charged today. If leads is not higher than today's plan, the change is scheduled for the next billing date instead. Run preview_plan_change first, show the price and get an explicit yes. Confirm with the user before calling. Returns status (active, requires_action or scheduled), chargedNowCents and nextBillingDate; requires_action means the bank wants the cardholder to confirm the payment: give the user confirmUrl (or send them to the Billing page). 402 means the card was declined, 409 means the subscription is paused.
| Connection | Account-owner URL or OAuth (not a team member URL) |
|---|
Parameters
| Parameter | Type | Required | Accepts | Description |
|---|---|---|---|---|
leads | integer | Yes | 1–1000000 | Leads per month of the new plan: a whole number from 1 to 1,000,000; use the same value you previewed. |
annual | boolean | No | any | 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": "upgrade_plan",
"title": "Upgrade plan",
"annotations": {
"title": "Upgrade plan",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"type": "object",
"properties": {
"leads": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"description": "Leads per month of the new plan: a whole number from 1 to 1,000,000; use the same value you previewed."
},
"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"
]
}
}