Account

Overage: state, rate and ceiling

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.

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

Headers

X-API-Keystring
X-RapidAPI-Proxy-Secretstring

Response

Successful Response

enabledboolean required
eligibleboolean required
rate_per_1000_centsinteger required
max_creditsinteger required
ceilinginteger required
credits_over_this_periodinteger required
estimated_cents_this_periodinteger required
planstring required
credits_limitinteger required
credits_usedinteger required

Example response

{
  "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
}

Changes

No recorded changes to this operation across all 1 revision of this API.