GET /v1/billing/overage

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.

Request

curl 'https://api.puntersedge.online/v1/billing/overage' \
  -H 'X-API-Key: YOUR_KEY'

Parameters

This endpoint takes no parameters beyond authentication.

Responses

Status codes: 200, 401, 402, 422, 429, 500. Response bodies are JSON; the full schema is in /openapi.json.

Example response

200 application/json — this call costs 0 credits. Field names and types are as the API returns them; values are a real sample, trimmed to a few items.

{
  "ceiling": 450000,
  "credits_limit": 300000,
  "credits_over_this_period": 12400,
  "credits_used": 312400,
  "eligible": true,
  "enabled": true,
  "estimated_cents_this_period": 780,
  "max_credits": 150000,
  "plan": "pro_plus",
  "rate_per_1000_cents": 60
}

Related endpoints

• GET /v1/account — Your account: email, plan, password, billing and consent status
• POST /v1/account/marketing — Turn promotional emails on or off for your account
• POST /v1/account/password — Set or change your account password
• POST /v1/billing/overage — Switch overage on or off
• GET /v1/billing/portal — Self-service billing portal link
• POST /v1/billing/portal — Billing portal link (console; confirms your password)
• GET /v1/billing/upgrade-link — A signed link to your prorated upgrade page
• POST /v1/billing/upgrade-link — Prorated upgrade link (console; confirms your password)