| title | BudgetLimit |
|---|---|
| description | BudgetLimit Schema Reference |
| Property | Type | Required | Description |
|---|---|---|---|
| type | Enum<'global' | 'user' | 'agent' | 'object' | 'project' | 'department'> |
✅ | |
| scope | string |
optional | Scope identifier (userId, agentId, etc.) |
| maxCost | number |
✅ | Maximum cost limit |
| currency | string |
optional | |
| period | Enum<'hourly' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' | 'custom'> |
✅ | |
| customPeriodDays | integer |
optional | Custom period in days |
| softLimit | number |
optional | Soft limit for warnings |
| warnThresholds | number[] |
optional | Warning thresholds (e.g., [0.5, 0.8, 0.95]) |
| enforced | boolean |
optional | Block requests when exceeded |
| gracePeriodSeconds | integer |
optional | Grace period after limit exceeded |
| allowRollover | boolean |
optional | Allow unused budget to rollover |
| maxRolloverPercentage | number |
optional | Max rollover as % of limit |
| name | string |
optional | Budget name |
| description | string |
optional | |
| active | boolean |
optional | |
| tags | string[] |
optional |