PlatformDocs
MCP server

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.

View as Markdown

Get auto top-up · Read-only

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. Returns eligible (true only on an active, unpaused paid subscription with a card on file; false on a trial or lifetime plan), enabled, packLeads, capUsd and minCapUsd (the lowest cap allowed: your plan price), perLeadCents and packPriceCents, spentThisCycleCents and refreshOn (when the cycle restarts), lowThreshold (credits left when it buys), recent (the last 10 top-ups), extraLeads (bought leads still unused; they roll over) and monthlyLeadsLeft. Free.

ConnectionAccount-owner URL or OAuth (not a team member URL)

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringNoanyOptional, kept for older callers: auto top-up is set per account, so the result is the same for every website.

Tool definition

What your assistant receives from tools/list:

{
  "name": "get_auto_topup",
  "title": "Get auto top-up",
  "annotations": {
    "title": "Get auto top-up",
    "readOnlyHint": true,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Optional, kept for older callers: auto top-up is set per account, so the result is the same for every website."
      }
    }
  }
}

On this page