scriptoriumadmin/litellm
1
0
Fork 0
mirror of https://github.com/BerriAI/litellm.git synced 2026-09-06 08:16:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 79

docs(proxy): account for budget rollover and daily upserts in spend wording

Browse source
This commit is contained in:
mateo-berri 2026-08-31 11:19:11 -07:00
parent 36c53e1288
commit e938e89d13
2 changed files with 28 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
litellm/proxy/management_endpoints/internal_user_endpoints.py
View file

@ -997,12 +997,13 @@ async def user_info_v2(
This is the v2 replacement for /user/info, designed to avoid the "god endpoint" problem
where the old endpoint loaded all keys and teams into memory.
Note on `spend`: this is the user's running budget counter, which is zeroed by the
budget reset job whenever `budget_reset_at` elapses (see `budget_duration`). It is NOT
Note on `spend`: this is the user's running budget counter, which the budget reset job
resets whenever `budget_reset_at` elapses (see `budget_duration`): to zero by default,
or to the overage above `max_budget` when `budget_rollover` is enabled. It is NOT
lifetime or per-period historical spend. For historical spend over a date range, use
`/user/daily/activity` or `/user/daily/activity/aggregated`, which read immutable daily
spend records that are never reset. The two values are expected to diverge once a
budget reset has occurred within the queried period.
`/user/daily/activity` or `/user/daily/activity/aggregated`, which read daily spend
records that only ever accumulate and are never reset. The two values are expected to
diverge once a budget reset has occurred within the queried period.
Access control:
- Proxy admins can query any user
@ -2694,9 +2695,10 @@ async def get_user_daily_activity(
Meant to optimize querying spend data for analytics for a user.
Reads immutable daily spend records, which are never affected by budget resets.
This can legitimately exceed the `spend` field returned by `/v2/user/info`, which
is a running budget counter zeroed on every budget reset.
Reads daily spend records that only ever accumulate and are never affected by budget
resets. Their total can legitimately exceed the `spend` field returned by
`/v2/user/info`, which is a running budget counter that every budget reset sets back
to zero (or to the overage above `max_budget` when `budget_rollover` is enabled).
Returns:
(by date)
@ -2812,9 +2814,10 @@ async def get_user_daily_activity_aggregated(
Aggregated analytics for a user's daily activity without pagination.
Returns the same response shape as the paginated endpoint with page metadata set to single-page.
Reads immutable daily spend records, which are never affected by budget resets.
This can legitimately exceed the `spend` field returned by `/v2/user/info`, which
is a running budget counter zeroed on every budget reset.
Reads daily spend records that only ever accumulate and are never affected by budget
resets. Their total can legitimately exceed the `spend` field returned by
`/v2/user/info`, which is a running budget counter that every budget reset sets back
to zero (or to the overage above `max_budget` when `budget_rollover` is enabled).
"""
from litellm.proxy.proxy_server import prisma_client

25
ui/litellm-dashboard/src/lib/http/schema.d.ts generated vendored
View file

@ -16210,9 +16210,10 @@ export interface paths {
*
* Meant to optimize querying spend data for analytics for a user.
*
* Reads immutable daily spend records, which are never affected by budget resets.
* This can legitimately exceed the `spend` field returned by `/v2/user/info`, which
* is a running budget counter zeroed on every budget reset.
* Reads daily spend records that only ever accumulate and are never affected by budget
* resets. Their total can legitimately exceed the `spend` field returned by
* `/v2/user/info`, which is a running budget counter that every budget reset sets back
* to zero (or to the overage above `max_budget` when `budget_rollover` is enabled).
*
* Returns:
* (by date)
@ -16246,9 +16247,10 @@ export interface paths {
* @description Aggregated analytics for a user's daily activity without pagination.
* Returns the same response shape as the paginated endpoint with page metadata set to single-page.
*
* Reads immutable daily spend records, which are never affected by budget resets.
* This can legitimately exceed the `spend` field returned by `/v2/user/info`, which
* is a running budget counter zeroed on every budget reset.
* Reads daily spend records that only ever accumulate and are never affected by budget
* resets. Their total can legitimately exceed the `spend` field returned by
* `/v2/user/info`, which is a running budget counter that every budget reset sets back
* to zero (or to the overage above `max_budget` when `budget_rollover` is enabled).
*/
get: operations["get_user_daily_activity_aggregated_user_daily_activity_aggregated_get"];
put?: never;
@ -21012,12 +21014,13 @@ export interface paths {
* This is the v2 replacement for /user/info, designed to avoid the "god endpoint" problem
* where the old endpoint loaded all keys and teams into memory.
*
* Note on `spend`: this is the user's running budget counter, which is zeroed by the
* budget reset job whenever `budget_reset_at` elapses (see `budget_duration`). It is NOT
* Note on `spend`: this is the user's running budget counter, which the budget reset job
* resets whenever `budget_reset_at` elapses (see `budget_duration`): to zero by default,
* or to the overage above `max_budget` when `budget_rollover` is enabled. It is NOT
* lifetime or per-period historical spend. For historical spend over a date range, use
* `/user/daily/activity` or `/user/daily/activity/aggregated`, which read immutable daily
* spend records that are never reset. The two values are expected to diverge once a
* budget reset has occurred within the queried period.
* `/user/daily/activity` or `/user/daily/activity/aggregated`, which read daily spend
* records that only ever accumulate and are never reset. The two values are expected to
* diverge once a budget reset has occurred within the queried period.
*
* Access control:
* - Proxy admins can query any user