Firecrawl credit usage
firecrawl_credit_usageRetrieve your Firecrawl team's current credit balance or 90-day usage history, optionally broken down by endpoint or API key, to track remaining credits and spending.
Instructions
Get the authenticated Firecrawl team's current credit balance or its credit usage over the last 90 days. Use the current view to answer how many credits remain or to check billing-period boundaries. Use the historical view to answer what credits were spent on and when.
The current view returns remainingCredits, planCredits, billingPeriodStart, and billingPeriodEnd. Extra purchased or granted credits can make remainingCredits greater than planCredits. Billing-period dates may be null when the upstream billing provider has no period metadata.
The historical view returns periods sorted by start date with startDate, endDate, and creditsUsed, one per calendar month, or one per UTC day with bin: "day". Set byEndpoint to split each period by the endpoint that used the credits (endpoint: scrape, search, crawl, map, agent, ...), or byApiKey to split it by API key (apiKey). The endpoint split also counts search usage, which the unsplit and per-key figures leave out, so its rows can add up to more. The newest period's endDate can be null. A notice means the requested split or daily periods are not available yet and the periods are monthly figures.
This tool cannot attribute credits to individual jobs, URLs, or MCP clients. Each tool's own result reports what that call used (creditsUsed, or metadata.creditsUsed on scrapes), and the Usage and Logs pages of the Firecrawl dashboard list usage per job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bin | No | Length of each historical period: calendar month (default) or UTC day. When view is omitted, it selects the historical view; it cannot be combined with view "current". | |
| view | No | Select current balance or historical usage. Defaults to current. | |
| byApiKey | No | Break historical usage down by API key. When view is omitted, true selects the historical view; it cannot be combined with view "current". | |
| byEndpoint | No | Break historical usage down by endpoint (scrape, search, crawl, map, agent, ...). When view is omitted, true selects the historical view; it cannot be combined with view "current" or byApiKey. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bin | No | Period length the API applied, `month` or `day`; present when the API applied a requested endpoint split or daily periods. | |
| error | No | Error message or error object when the call did not succeed. | |
| notice | No | Present when the requested split or daily periods are not available yet; the periods are then calendar-month figures. | |
| periods | No | Historical periods sorted by start date, each with `startDate`, `endDate`, `creditsUsed`, and `endpoint` or `apiKey` when split. | |
| success | No | Whether the API call succeeded. | |
| planCredits | No | Credits included in the plan for the period. | |
| billingPeriodEnd | No | End of the current billing period; null when the billing provider reports no period. | |
| remainingCredits | No | Credits left in the current billing period; can exceed `planCredits` when extra credits were purchased or granted. | |
| billingPeriodStart | No | Start of the current billing period; null when the billing provider reports no period. |