set_auto_topup
Turns auto top-up on or off and sets the pack of leads bought each time credits run out and the monthly cap in USD.
Set auto top-up · Changes data · Acts outside your account
Turns auto top-up on or off and sets the pack of leads bought each time credits run out and the monthly cap in USD. When on, the card on file is charged automatically up to the cap. Account owners and billing admins only. Returns the same summary as get_auto_topup: when eligible is false (a trial or lifetime plan, a paused plan or no card on file) the setting is saved but nothing will be bought, so tell the user.
| Connection | Account-owner URL or OAuth (not a team member URL) |
|---|
Parameters
| Parameter | Type | Required | Accepts | Description |
|---|---|---|---|---|
websiteId | string | No | any | Optional, kept for older callers: auto top-up is set per account, so it changes the same setting for every website. |
enabled | boolean | Yes | any | true to buy leads automatically, false to stop. |
packLeads | integer | No | 1–100000 | Leads bought each time credits run out: a whole number from 1 to 100,000. Needed the first time you turn it on; the price per lead is your plan's (perLeadCents in get_auto_topup). |
capUsd | number | No | min 1 | Most auto top-up may spend per billing cycle, in USD. At least your plan's monthly price (minCapUsd in get_auto_topup); a lower value is refused. Leave it out to keep the current limit. |
Tool definition
What your assistant receives from tools/list:
{
"name": "set_auto_topup",
"title": "Set auto top-up",
"annotations": {
"title": "Set auto top-up",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
},
"inputSchema": {
"type": "object",
"properties": {
"websiteId": {
"type": "string",
"description": "Optional, kept for older callers: auto top-up is set per account, so it changes the same setting for every website."
},
"enabled": {
"type": "boolean",
"description": "true to buy leads automatically, false to stop."
},
"packLeads": {
"type": "integer",
"minimum": 1,
"maximum": 100000,
"description": "Leads bought each time credits run out: a whole number from 1 to 100,000. Needed the first time you turn it on; the price per lead is your plan's (perLeadCents in get_auto_topup)."
},
"capUsd": {
"type": "number",
"minimum": 1,
"description": "Most auto top-up may spend per billing cycle, in USD. At least your plan's monthly price (minCapUsd in get_auto_topup); a lower value is refused. Leave it out to keep the current limit."
}
},
"required": [
"enabled"
]
}
}get_auto_topup
Whether auto top-up is on: when credits run out, a pack of leads is bought automatically at your plan's price per lead, up to a monthly cap in USD.
get_billing
Returns the same subscription summary as get_subscription: plan, leads per month, credits used and remaining, top-up credits, price, billing interval, next billing date, whether it is set to cancel or is paused, pending downgrade and any running retention discount.