billing

Billing Agent Plan Overage

Turn Developer-plan extra calls on with a monthly limit, change it, or turn them off. Body: {cap_usd}.

post/api/billing/agent-plan/overage

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/overage
  • Auth: none declared

Response

Successful Response

statusstring required

'ok' on a write.

planstring nullable

The active plan key the consent was recorded for.

overage_enabledboolean required

Extra calls are ON after this write.

overage_per_call_usdnumber nullable

The rate recorded on the consent row.

overage_cap_usdnumber nullable

The limit recorded on the consent row; null when off.

overage_cap_default_usdnumber nullable

The offered default limit.

overage_cap_max_usdnumber nullable

The highest settable limit.

consent_idinteger nullable

metered_consents.id of the new live row; null when off.

urlstring nullable

Where the terms are documented.

errorstring nullable

Set only on a refusal branch.

messagestring nullable

Set only on a refusal branch (api_error envelope).

reasonstring nullable

Refusal reason from the closed vocabulary; only on a refusal.

Changes

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