{"openapi":"3.1.0","info":{"title":"GET /api/v1/billing/ai-usage/details","version":"1.0.0","description":"Get Ai Usage Details"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/billing/ai-usage/details":{"get":{"tags":["billing"],"summary":"Get Ai Usage Details","description":"Return detailed AI usage stats: top users, model breakdown, daily trend.\n\n**Query Parameters:**\n- `scope`: Optional. Set to 'firm' to see firm-wide AI usage.\n\n**Returns:** Summary, top_users, by_model, daily arrays.","operationId":"get_ai_usage_details_api_v1_billing_ai_usage_details_get","parameters":[{"name":"scope","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set to 'firm' to aggregate across all firm businesses.","title":"Scope"},"description":"Set to 'firm' to aggregate across all firm businesses."},{"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_GetAiUsageDetailsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AIUsageByModel":{"properties":{"model":{"type":"string","title":"Model"},"requests":{"type":"integer","title":"Requests"},"tokens":{"type":"integer","title":"Tokens"},"pct":{"type":"number","title":"Pct"}},"additionalProperties":true,"type":"object","required":["model","requests","tokens","pct"],"title":"AIUsageByModel"},"AIUsageDaily":{"properties":{"date":{"type":"string","title":"Date"},"requests":{"type":"integer","title":"Requests"},"tokens":{"type":"integer","title":"Tokens"}},"additionalProperties":true,"type":"object","required":["date","requests","tokens"],"title":"AIUsageDaily"},"AIUsageDetailsSummary":{"properties":{"requests_used":{"type":"integer","title":"Requests Used"},"monthly_limit":{"type":"integer","title":"Monthly Limit"},"is_unlimited":{"type":"boolean","title":"Is Unlimited"},"total_tokens":{"type":"integer","title":"Total Tokens"},"estimated_cost_usd":{"type":"number","title":"Estimated Cost Usd"},"unique_users":{"type":"integer","title":"Unique Users"},"plan_tier":{"type":"string","title":"Plan Tier"},"has_ai_pro":{"type":"boolean","title":"Has Ai Pro"},"is_trial":{"type":"boolean","title":"Is Trial"}},"additionalProperties":true,"type":"object","required":["requests_used","monthly_limit","is_unlimited","total_tokens","estimated_cost_usd","unique_users","plan_tier","has_ai_pro","is_trial"],"title":"AIUsageDetailsSummary"},"AIUsageTopUser":{"properties":{"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"name":{"type":"string","title":"Name"},"requests":{"type":"integer","title":"Requests"},"tokens":{"type":"integer","title":"Tokens"},"pct":{"type":"number","title":"Pct"}},"additionalProperties":true,"type":"object","required":["name","requests","tokens","pct"],"title":"AIUsageTopUser"},"GetAiUsageDetailsResponse":{"properties":{"summary":{"$ref":"#/components/schemas/AIUsageDetailsSummary"},"top_users":{"items":{"$ref":"#/components/schemas/AIUsageTopUser"},"type":"array","title":"Top Users"},"by_model":{"anyOf":[{"items":{"$ref":"#/components/schemas/AIUsageByModel"},"type":"array"},{"type":"null"}],"title":"By Model"},"daily":{"items":{"$ref":"#/components/schemas/AIUsageDaily"},"type":"array","title":"Daily"}},"additionalProperties":true,"type":"object","required":["summary","top_users","daily"],"title":"GetAiUsageDetailsResponse","description":"Response for ``get_ai_usage_details``."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_GetAiUsageDetailsResponse_":{"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/GetAiUsageDetailsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetAiUsageDetailsResponse]"},"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":[]}]}