PlatformDocs

Plan, billing & credits

Your plan, who can manage it, invoices and how credits are used.

View as Markdown

Connect the MCP server, then just ask.

get_accountShows the signed-in account: plan, credit limits and remaining credits, refresh and trial dates, add-ons, features, settings, pause status, failed-payment flag and the account's websites (the first 11 only).Read-only
get_billingReturns 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.Read-only
get_credit_historyLists the account's credit transactions from the last 90 days, newest first: each row has operation (CHARGE, REFUND or DUPLICATE_PREVENTED), amount, credits before/after, the website, the lead's domain/email, a source category (WEBSITE_VISITOR, INTENT_SIGNALS, WEB_SCRAPING, PROSPECTOR, ENRICHMENT, EMAIL_VERIFICATION, CONTACT_UNLOCK, ADJUSTMENT, OTHER), a reason and createdAt.Read-only
get_subscriptionShows 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.Read-only
preview_plan_changeShows what a plan change would cost without changing anything.Read-only
upgrade_planMoves the subscription to more leads per month right away and charges the card on file today.Changes data · Credits
downgrade_planSchedules the subscription to change to a new number of leads per month from the next billing date; nothing is charged or refunded now and current credits stay until then.Changes data
pause_subscriptionPauses the subscription for 1 to 6 months: invoices during the pause are not collected, no new leads come in while paused, and it resumes automatically on pausedUntil.Deletes data
cancel_subscriptionCancels the subscription at the end of the current billing period (it stays usable until then) and records why.Deletes data
reactivate_subscriptionUndoes a cancellation that has not taken effect yet, or ends a pause early.Changes data
get_website_credit_historyReturns the credit snapshots stored for one website: each entry has creditsLimit, creditsRemaining, creditsUsed, refreshOn and timestamps.Read-only
list_invoicesThe account's invoices, newest first: date, amount, refunded amount, currency, status (paid, open, void, uncollectible, refunded, partially_refunded), description (what it was for), a link to the PDF and hosted (the invoice's web page, where an open one can be paid).Read-only
get_auto_topupWhether 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.Read-only
set_auto_topupTurns auto top-up on or off and sets the pack of leads bought each time credits run out and the monthly cap in USD.Changes data
get_credit_summaryCredits 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.Read-only
list_billing_domainsThe account's sending domains with their billing: price and renewalPrice (USD a year), expiresAt (renewal date), autoRenew and cancelAtPeriodEnd, setupCompleted and activeDate.Read-only
list_open_invoicesThe account invoices that are still unpaid (open or past due): amount, currency, due date, what it is for, the payment status, the PDF link and hosted (the page where it can be paid); at most 5, newest first; plus the next upcoming invoice (amount and the date the period ends), or null on a cancelled or lifetime plan.Read-only

Use case

How many credits do I have left this month?

Called get_accountShow input
{}

How many credits did we use last month, and on what?

Called get_credit_summaryShow input
{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9", "cycle": 1 }

The answer splits the cycle by source (website visitors, Prospector, enrichment…) and by day. cycle goes back up to 5 billing cycles.

Where did my Prospector credits go this month?

Called get_credit_historyShow input
{ "source": "PROSPECTOR", "operation": "CHARGE", "from": "2026-10-01" }

When is my next bill, and how much will it be?

Called get_subscriptionShow input
{}

It answers the plan, leads per month, price, billing interval (monthly or yearly), next billing date and whether the plan is set to cancel, paused or downgrading. Without a paid subscription the price fields are empty.

Is auto top-up on, and what's my monthly limit?

Called get_auto_topupShow input
{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9" }

Turn on auto top-up: 500 leads at a time, no more than $300 a month.

Called set_auto_topupShow input
{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9", "enabled": true, "packLeads": 500, "capUsd": 300 }

Which of our sending domains renew in the next two months, and for how much?

Called list_billing_domainsShow input
{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9" }

Each domain comes with its yearly price, renewal date and whether it renews automatically. Domains you brought yourself (source: "imported") renew at your own registrar and are never billed here.

Show my unpaid invoices and what my next bill will be.

Called list_open_invoicesShow input
{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9" }

What would 10,000 leads a month cost us, and what would we pay today?

Called preview_plan_changeShow input
{ "leads": 10000 }

Nothing changes: it answers the new monthly price and what would be charged today. Your assistant keeps your billing interval (monthly or yearly) unless you ask to switch. Run it before upgrade_plan, which charges the card.

Yes, go ahead: move us to 10,000 leads a month.

Called upgrade_planShow input
{ "leads": 10000 }

The card on file is charged today for the extra leads, and the new credits are there straight away. If your bank asks you to confirm the payment, the answer comes back with a link (confirmUrl) where you confirm it.

We don't need 5,000 leads a month any more. Move us to 3,000 from the next bill.

Called downgrade_planShow input
{ "leads": 3000 }

Nothing is charged or refunded now: the smaller plan starts at the next billing date, and your current credits stay until then. Plans go up to 1,000,000 leads a month; for more, contact us.

We're closed for the holidays. Pause our plan for 2 months.

Called pause_subscriptionShow input
{ "months": 2 }

Pauses last 1 to 6 whole months. Nothing is charged and no new leads come in while paused; the plan resumes by itself on the date in the answer (pausedUntil), or earlier with reactivate_subscription.

Cancel my subscription. It's too expensive for us right now, the budget was cut.

Called cancel_subscriptionShow input
{ "reason": "expensive", "feedback": "Budget was cut this quarter." }

Your assistant asks you to confirm before it cancels. The plan stays usable until the end of the billing period, and reactivate_subscription undoes the cancellation before then. If you would rather keep your data and pay less, ask it to pause (pause_subscription) or downgrade (downgrade_plan) instead.

Actually, keep our subscription. Undo the cancellation.

Called reactivate_subscriptionShow input
{}

It undoes a cancellation that has not taken effect yet, or ends a pause early (billing restarts). If nothing was cancelled or paused, it changes nothing and says so.

On this page