PlatformDocs
MCP server

get_credit_summary

Credits used in a billing cycle, by source (website visitors, Prospector, AI Scout, Web Scraping…) and by day (byDay: charges, refunds and duplicates prevented per date, UTC), with the plan limit, what is left and leads bought.

View as Markdown

Get the credit summary · Read-only

Credits used in a billing cycle, by source (website visitors, Prospector, AI Scout, Web Scraping…) and by day (byDay: charges, refunds and duplicates prevented per date, UTC), with the plan limit, what is left and leads bought. For single credit events use get_credit_history. Free.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite ID from list_websites.
cycleintegerNo0–5 · default 0Which billing cycle: 0 = the current one (default), 1 = the one before, up to 5 (the last six cycles are kept; none before the account was created). The answer's cycles list shows each one's dates.

Tool definition

What your assistant receives from tools/list:

{
  "name": "get_credit_summary",
  "title": "Get the credit summary",
  "annotations": {
    "title": "Get the credit summary",
    "readOnlyHint": true,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website ID from list_websites."
      },
      "cycle": {
        "type": "integer",
        "minimum": 0,
        "maximum": 5,
        "default": 0,
        "description": "Which billing cycle: 0 = the current one (default), 1 = the one before, up to 5 (the last six cycles are kept; none before the account was created). The answer's cycles list shows each one's dates."
      }
    },
    "required": [
      "websiteId"
    ]
  }
}

On this page