UNunusual
agent_desk

Update Agent Desk Overage

Set the payer org's overage credit allowance — the customer's opt-in to pay per credit past the plan's bundle (Billing page). Off by default.

Money fails closed, so three refusals guard the write:

  • get_domain alone admits AGENCY-GRANT holders, and a grant never confers billing mutation (models.py) — the caller must BELONG to the domain's org (or be staff), the binding payments.py uses;
  • a domain whose bills land on ANOTHER org (agency billing) cannot move the payer's allowance;
  • a plan row with no metered Stripe price cannot ENABLE overage: the gate would serve credits nothing can bill. Disabling (0/null) always works.

Takes effect on the next ask: the serving gate reads the org row live.

patch/api/domains/{domain_id}/agent-desk/usage/overage

Request

  • Base URL
    https://api-v1.unusual.ai (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

domain_idstring required

Headers

x-view-asstring nullable

Request body

overage_credit_limitinteger nullable

Response

Successful Response

answers_todayinteger nullable required
answers_limitinteger nullable required
answers_limit_sourcestring required
answers_reset_in_secondsinteger required
published_pagesinteger required
published_pages_includedinteger nullable required
plan_namestring nullable required
can_pick_subdomainboolean
ingested_sourcesinteger
ingested_sources_includedinteger nullable
free_planboolean

Changes

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