---
title: "Get By User"
method: GET
path: "/admin/finance/by-user"
tags: ["admin"]
---

# Get By User

`GET /admin/finance/by-user`

## Request

- Base URL: `https://api.framesail.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.framesail.com/admin/finance/by-user`
- Auth: HTTP bearer

## Query parameters

- `state` 'paid' | 'inactive', nullable
- `start` string, date, nullable: Inclusive start date (YYYY-MM-DD)
- `end` string, date, nullable: Inclusive end date (YYYY-MM-DD)

## Response `200`

Successful Response

- UserBreakdown
  - `items` UserSpend[], required
    - `user_id` string, required
    - `email` string, nullable, required
    - `full_name` string, nullable, required
    - `plan_id` string, required
    - `sub_status` string, required
    - `billing_state` 'paid' | 'inactive', required
    - `our_cost_usd` number, required
    - `byok_cost_usd` number, required
    - `op_count` integer, required
    - `revenue_usd` number, required
    - `margin_usd` number, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/framesail/apis/framesail-api.md) · [All operations](https://skmtc.dev/framesail/apis/framesail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/framesail/apis/framesail-api/revisions/12602eae0820?raw)