billing
team

Billing Agent Plan

Active Developer plan + usage + the sellable plans (AgentPlanStatusResponse).

get/api/billing/agent-plan

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/billing/agent-plan
  • Auth: none declared

Response

Successful Response

planstring nullable

Active AGENT_API_PLANS key, or null = pay-as-you-go.

plan_namestring nullable

Display name of the active plan, or null.

price_mointeger nullable

USD/month of the active plan, or null.

included_callsinteger nullable

Monthly allowance of the active plan, or null.

used_callsinteger required

Class-A calls metered this calendar month (UTC).

remaining_callsinteger nullable

included - used, floored at 0; null on pay-as-you-go.

hard_stoppedboolean required

True when the NEXT call is refused (used >= included and no overage rate). 'You are blocked right now', not 'you went over'.

monthstring required

The usage month, 'YYYY-MM' (UTC).

overage_availableboolean

The active plan offers extra calls at a rate (false on pay-as-you-go and on a degraded consent read -- never offer an opt-in we cannot verify).

overage_enabledboolean

A LIVE mcp_tools consent row exists: extra calls are ON.

overage_reconsent_requiredboolean

The live consent is at a different rate than the current plan's (a plan change) -- extra calls pause until re-confirmed.

overage_degradedboolean

The consent / ledger read FAILED; the overage_* fields are unknown, not off. The next over-call is refused (fail-closed).

overage_per_call_usdnumber nullable

The plan's rate (the quote).

overage_agreed_per_call_usdnumber nullable

The rate on the live consent row -- the one that bills; null when off.

overage_cap_usdnumber nullable

The agreed monthly limit on the live consent row; null when off.

overage_cap_default_usdnumber nullable

The offered default limit.

overage_cap_max_usdnumber nullable

The highest settable limit.

overage_accrued_usdnumber

Extra calls accrued this month under the live consent, priced at its agreed rate and clamped at its cap; not yet settled.

overage_settled_usdnumber

Extra calls already settled this month (settle-on-change ledger).

overage_urlstring nullable

Where the rate, the cap and the route that sets it are documented.

errorstring nullable

Set ONLY on the 503 (billing unavailable) / 500 (lookup failed) branches, where the route answers {error} and nothing else; the API-keys panel reads it before touching plans (tools/check_fe_api_key_agreement.py, 2026-09-13).

Changes

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