# Billing summary: `GET /v1/billing`

Cost: free (0 (failed requests are free)). Docs: https://scrapercompany.com/docs/reference/billing

Plan, credit balance and when the current period ends.

The first call a new integration should make: it reports whether the key
is metered at all, what it has left and what renews when. Free.

Response fields:

- `mode` (string; required; one of off, shadow, enforce): Credit metering mode. `enforce`: a request that needs more credits than are available gets 402, and the plan's concurrent-request limit applies (429). `shadow`: every request is metered and recorded but never blocked. `off`: not metered.
- `plan` (object; required)
  - `plan.code` (string; required; one of free, starter, growth, scale, enterprise): Plan code.
  - `plan.name` (string; required)
  - `plan.monthly_credits` (integer; required): Credits granted at the start of each period.
  - `plan.price_usd` (integer; required): Monthly price in USD; 0 = free, -1 = custom (sales).
  - `plan.concurrency` (integer; required): Concurrent metered requests allowed; applied in `enforce` mode.
- `credits` (object; required)
  - `credits.balance` (integer; required): Credits on the account. In `enforce` mode requests are refused before it would go below zero; in `shadow` mode it can go negative and the overdraft is forgiven at renewal.
  - `credits.reserved` (integer; required): Credits held by requests that are still running.
  - `credits.available` (integer; required): `balance - reserved`.
  - `credits.credits_used` (integer; required): Credits charged this period.
  - `credits.credits_refunded` (integer; required): Credits returned this period.
  - `credits.billable_requests` (integer; required): Requests charged this period.
- `period` (object; required)
  - `period.start` (string (date-time); required)
  - `period.end` (string (date-time); required): Renewal time; unspent credits expire then.
- `subscription` (object; optional)
  - `subscription.status` (string; optional)
  - `subscription.stripe_managed` (boolean; optional)

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
