{"openapi":"3.1.0","info":{"title":"GET /api/v1/billing/firm/client-usage","version":"1.0.0","description":"Get Firm Client Usage"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/billing/firm/client-usage":{"get":{"tags":["billing"],"summary":"Get Firm Client Usage","description":"Return the firm's active client count, tier cap, and remaining seats.\n\nFor non-advisory businesses (self-directed/managed) this returns\n``is_advisory_firm: false`` with no limit so callers can hide the\nclient/upgrade UI.","operationId":"get_firm_client_usage","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_GetFirmClientUsageResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"get_firm_client_usage_api_v1_billing_firm_client_usage_get"}}},"components":{"schemas":{"FirmTierOption":{"properties":{"value":{"type":"string","title":"Value"},"client_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Limit"}},"additionalProperties":true,"type":"object","required":["value"],"title":"FirmTierOption"},"GetFirmClientUsageResponse":{"properties":{"is_advisory_firm":{"type":"boolean","title":"Is Advisory Firm"},"firm_plan_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firm Plan Tier"},"active_clients":{"type":"integer","title":"Active Clients"},"client_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Limit"},"seats_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seats Remaining"},"can_add_client":{"type":"boolean","title":"Can Add Client"},"tiers":{"items":{"$ref":"#/components/schemas/FirmTierOption"},"type":"array","title":"Tiers"},"firm_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firm Id"}},"additionalProperties":true,"type":"object","required":["is_advisory_firm","active_clients","can_add_client","tiers"],"title":"GetFirmClientUsageResponse","description":"Response for ``get_firm_client_usage``."},"SuccessEnvelope_GetFirmClientUsageResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/GetFirmClientUsageResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetFirmClientUsageResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}