---
title: "Overage: state, rate and ceiling"
method: GET
path: "/v1/billing/overage"
tags: ["Account"]
---

# Overage: state, rate and ceiling

`GET /v1/billing/overage`

## Request

- Base URL: `https://api.puntersedge.online`
- URL: `https://api.puntersedge.online/v1/billing/overage`
- Auth: API key in header `X-API-Key`

Cost: 0 credits. Whether this account may run past its monthly allowance, what that
costs, where it stops, and how much of it this period has used.

`ceiling` is the number the API actually enforces: when overage is off it equals your
credit limit, which is the hard 402 every plan has always had. `max_credits` is what the
plan allows when it is on. `estimated_cents_this_period` is what would be invoiced if the
month ended now — the same arithmetic the billing run uses, rounded up to whole 1,000s.

A team key sees the POOL's figures: overage belongs to the account, and a team key's own
monthly cap is hard.

## Headers

- `X-API-Key` string
- `X-RapidAPI-Proxy-Secret` string

## Response `200`

Successful Response

- OverageOut
  - `enabled` boolean, required
  - `eligible` boolean, required
  - `rate_per_1000_cents` integer, required
  - `max_credits` integer, required
  - `ceiling` integer, required
  - `credits_over_this_period` integer, required
  - `estimated_cents_this_period` integer, required
  - `plan` string, required
  - `credits_limit` integer, required
  - `credits_used` integer, required

## Other responses

- `401`: Missing or invalid API key. Send `X-API-Key`. See https://puntersedge.online/developers/errors
- `402`: Monthly credit allowance exhausted for this plan. Upgrade at https://puntersedge.online/api/pricing
- `422`: Validation Error
- `429`: Rate limit exceeded for this plan. Honour the `Retry-After` header (seconds) before retrying. See https://puntersedge.online/developers/rate-limits
- `500`: Unexpected server error. Safe to retry with backoff.

---

[API](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api.md) · [All operations](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api/llms.txt) · [OpenAPI document](https://skmtc.dev/puntersedge/apis/puntersedge-odds-api/revisions/f35b6aab1946?raw)