{"openapi":"3.1.0","info":{"title":"GET /api/v1/billing/ai-usage","version":"1.0.0","description":"Get Ai Usage"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/billing/ai-usage":{"get":{"tags":["billing"],"summary":"Get Ai Usage","description":"Return current daily and monthly AI request counts with plan limits.","operationId":"get_ai_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_GetAiUsageResponse_"}}}},"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_ai_usage_api_v1_billing_ai_usage_get"}}},"components":{"schemas":{"AIOverageBreakdown":{"properties":{"light":{"type":"integer","title":"Light"},"standard":{"type":"integer","title":"Standard"},"heavy":{"type":"integer","title":"Heavy"}},"additionalProperties":true,"type":"object","required":["light","standard","heavy"],"title":"AIOverageBreakdown"},"AIOverageRatesCents":{"properties":{"light":{"type":"integer","title":"Light"},"standard":{"type":"integer","title":"Standard"},"heavy":{"type":"integer","title":"Heavy"}},"additionalProperties":true,"type":"object","required":["light","standard","heavy"],"title":"AIOverageRatesCents"},"AIUpgradeSuggestion":{"properties":{"addon_or_plan_slug":{"type":"string","title":"Addon Or Plan Slug"},"label":{"type":"string","title":"Label"},"monthly_quota":{"type":"integer","title":"Monthly Quota"},"monthly_price_cents":{"type":"integer","title":"Monthly Price Cents"},"would_save_cents":{"type":"integer","title":"Would Save Cents"}},"additionalProperties":true,"type":"object","required":["addon_or_plan_slug","label","monthly_quota","monthly_price_cents","would_save_cents"],"title":"AIUpgradeSuggestion"},"GetAiUsageResponse":{"properties":{"requests_used":{"type":"integer","title":"Requests Used"},"monthly_limit":{"type":"integer","title":"Monthly Limit"},"remaining":{"type":"integer","title":"Remaining"},"is_unlimited":{"type":"boolean","title":"Is Unlimited"},"plan_tier":{"type":"string","title":"Plan Tier"},"has_ai_pro":{"type":"boolean","title":"Has Ai Pro"},"is_trial":{"type":"boolean","title":"Is Trial"},"overage_enabled":{"type":"boolean","title":"Overage Enabled"},"overage_requests":{"type":"integer","title":"Overage Requests"},"overage_rates_cents":{"$ref":"#/components/schemas/AIOverageRatesCents"},"overage_breakdown":{"$ref":"#/components/schemas/AIOverageBreakdown"},"estimated_overage_cost_cents":{"type":"integer","title":"Estimated Overage Cost Cents"},"projected_month_end_overage_cents":{"type":"integer","title":"Projected Month End Overage Cents"},"ai_paused_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ai Paused At"},"ai_paused_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ai Paused By"},"upgrade_suggestion":{"anyOf":[{"$ref":"#/components/schemas/AIUpgradeSuggestion"},{"type":"null"}]},"disabled_features_when_paused":{"items":{"type":"string"},"type":"array","title":"Disabled Features When Paused"}},"additionalProperties":true,"type":"object","required":["requests_used","monthly_limit","remaining","is_unlimited","plan_tier","has_ai_pro","is_trial","overage_enabled","overage_requests","overage_rates_cents","overage_breakdown","estimated_overage_cost_cents","projected_month_end_overage_cents","disabled_features_when_paused"],"title":"GetAiUsageResponse","description":"Response for ``get_ai_usage`` (also returned by pause/resume)."},"SuccessEnvelope_GetAiUsageResponse_":{"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/GetAiUsageResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetAiUsageResponse]"},"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":[]}]}