Ramp: List AI usage and estimated spend grouped by the requested dimensions — response body — data item
List AI usage and estimated spend grouped by the requested dimensions: response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List AI usage and estimated spend grouped by the requested dimensions — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cached_input_tokens | JSON | Required within parent | |
cached_input_tokens (anyOf 1) | integer | Alternative | Number of cached input tokens. |
cached_input_tokens (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
department_id | JSON | Required within parent | |
department_id (anyOf 1) | string | Alternative | Department of the Ramp user. Null unless group_by includes department, or when the user has no department. Format: uuid |
department_id (anyOf 2) | null | Alternative | |
estimated_cost | JSON | Required within parent | |
estimated_cost (anyOf 1) | Model | Alternative | Expand Fetch a payment — response body — amount Estimated cost, matching the AI Spend page. Null for AWS Bedrock, which Ramp reports as billed cost rather than an estimate. When rows combine AWS Bedrock with other providers, the estimate excludes AWS Bedrock. Read only: true |
estimated_cost (anyOf 2) | null | Alternative | |
input_tokens | JSON | Required within parent | |
input_tokens (anyOf 1) | integer | Alternative | Number of input tokens. |
input_tokens (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
model | JSON | Required within parent | |
model (anyOf 1) | string | Alternative | Provider model name. Null unless group_by includes model, or when the provider did not report one. |
model (anyOf 2) | null | Alternative | |
output_tokens | JSON | Required within parent | |
output_tokens (anyOf 1) | integer | Alternative | Number of output tokens. |
output_tokens (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
product | JSON | Required within parent | |
product (anyOf 1) | string | Alternative | Product the usage came from, such as claude_code, codex, or cursor. Null unless group_by includes product, or when no product applies. |
product (anyOf 2) | null | Alternative | |
provider | JSON | Required within parent | |
provider (anyOf 1) | string | Alternative | AI provider. Null unless group_by includes provider. Known values: ANTHROPIC, AWS, AZURE, CURSOR, FIREWORKS, GCP, OPENAI, RAMP Read only: true |
provider (anyOf 2) | null | Alternative | |
usage_date | string | Required within parent | UTC calendar date for this usage row. Format: date |
user_email | JSON | Required within parent | |
user_email (anyOf 1) | string | Alternative | Email of the Ramp user, or the email the provider reported when the usage is not attributed to a Ramp user. Null unless group_by includes user. Format: email |
user_email (anyOf 2) | null | Alternative | |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | Ramp user. Null unless group_by includes user, or when the usage is not attributed to a Ramp user. Format: uuid |
user_id (anyOf 2) | null | Alternative | |
web_search_requests | JSON | Required within parent | |
web_search_requests (anyOf 1) | integer | Alternative | Number of provider web-search requests. |
web_search_requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Fetch a payment — response body — amount