PlatformDocs

Plan, billing & credits

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

Authenticated with ?privateKey=YOUR_KEY (see Authentication). Plans, invoices and payment methods change only in the dashboard or through the MCP tools.

GET/v3/websites/{websiteId}/credit-historyGet website credit history
GET/v3/billing/invoicesList invoices
GET/v3/billing/auto-topupGet auto top-up
PUT/v3/billing/auto-topupSet auto top-up
GET/v3/credits/summaryGet the credit summary
GET/v3/billing/domainsList billed domains
GET/v3/billing/open-invoicesList open invoices
GET
Parameters
Website IdWebsite ID from list_websites (24-character ID).
curl -X GET "https://rest-dash.revealid.xyz/v3/websites/64b7f0a1c2d3e4f5a6b7c8d9/credit-history?privateKey=YOUR_KEY"
Response
Press Send request to try it with sample data.

What each field accepts

FieldTypeLimits and formatAccepted values
websiteId*string—any

Use case: Alert before credits run out

Read the latest snapshot every morning: when creditsRemaining falls below a tenth of creditsLimit, post to your team chat.

On this page