{"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_api_v1_billing_firm_client_usage_get","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/HTTPValidationError"}}}}}}}},"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``."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}