---
title: "Get the caller's budget."
method: GET
path: "/v1/user/budget"
tags: ["Metering"]
---

# Get the caller's budget.

`GET /v1/user/budget`

## Request

- Base URL: `https://api.scalix.world`
- URL: `https://api.scalix.world/v1/user/budget`
- Auth: HTTP bearer

Returns current usage (AI tokens, storage, compute hours), the plan's
allowances, and the remaining headroom for each.

## Response `200`

Usage, plan limits, and remaining allowance

- BudgetResponse: Response for `GET /v1/user/budget`.
  - `user_id` string, required
  - `usage` BudgetUsage, required: Usage figures (floats) — used for the current usage and remaining allowance.
    - `ai_tokens` number, double, required
    - `storage_gb` number, double, required
    - `compute_hours` number, double, required
  - `limits` BudgetLimits, required: Plan allowances.
    - `ai_tokens` integer, required
    - `storage_gb` number, double, required
    - `compute_hours` number, double, required
  - `remaining` BudgetUsage, required: Usage figures (floats) — used for the current usage and remaining allowance.
    - `ai_tokens` number, double, required
    - `storage_gb` number, double, required
    - `compute_hours` number, double, required

## Other responses

- `401`: Missing or invalid credentials
- `500`: Database error

---

[API](https://skmtc.dev/scalix/apis/scalix-cloud-api.md) · [All operations](https://skmtc.dev/scalix/apis/scalix-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scalix/apis/scalix-cloud-api/revisions/2c04ca0a90bb?raw)