Billing

Whether the workspace may connect new domains

The lean read the MCP server's check-billing-status tool uses: whether a new connection is refused right now, and if so the same code, title and details the refusal carries (billing_required), plus the plan and this month's usage. It has no dates, amounts, invoices or card; owners and admins read those from GET /billing/status. Any workspace credential may read it: a tenant API key of any role, a delegated agent token with domains:read, or a widget token minted with scope app. A connect-scoped widget token (an end user's) is refused with 403.

get/billing/standing

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/billing/standing
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.customdomain.ai/oauth/agent/authorize, token URL https://api.customdomain.ai/oauth/agent/token, scopes: domains:read)

Response

The workspace's standing

configuredboolean required

Whether a workspace can subscribe on this deployment.

restrictedboolean required

New domain connections are refused right now.

first_domain_freeboolean

Present only when true: this is a new workspace on the first domain free rule. restricted is false until its free domains are connected, and true, with the refusal's words, after.

free_domainsinteger

Present with first_domain_free: how many domains the workspace may connect before it has a subscription. One, unless the operator granted more.

attentionboolean required

Billing needs an owner or admin: a trial or grace to act on, a failed payment, or a block.

codestring

Set when restricted: billing_required.

titlestring

Set when restricted: what the refusal says.

detailsstring

Set when restricted: why, and where an owner or admin fixes it.

billing_urlstring required

Where an owner or admin sets up billing.

Changes

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