Skip to content

Usage Object ​



id
string
REQUIRED · 

Unique identifier for the usage.

product
object

The product associated with the usage.

id
string
REQUIRED · 

Unique identifier for the product.

name
string

Name of the product.

metric_name
string

Name of the metric being charged for

resources
object[]
id
string

Unique identifier for the resource.

name
string

Name of the resource.

workspace
object

The resource is present in this workspace.

id
string

Unique identifier for the workspace.

name
string

Name of the workspace.

organization
object

The organization associated with the usage.

id
string
REQUIRED · 

Unique identifier for the organization.

name
string

Name of the organization.

user
object

User attributed to the usage row when the vendor exposes a user pivot. Omit for org-level or aggregated rows.

id
string

Unique identifier for the user in the source application.

email
string

Primary email of the user.

name
string

Display name of the user.

model
object

AI model for the row when applicable. Omit for non-AI vendors.

id
string

Model identifier (e.g. claude-sonnet-4-6, gpt-5).

provider
string

Provider hosting the model (e.g. anthropic, openai, cursor).

charges
object[]

The amounts charged for the usage.

amount
number

The amount charged for the usage.

currency
string

The currency in which the charge is made.

type
string

The type of charge.

All possible enum values:
  • total
  • net
  • on_demand
  • committed
  • included
  • usage_based
  • discount
  • tax
  • credit
  • platform_fee
usage
object

The usage data for the product.

quantity
number

Generic quantity (e.g. Confluent).

unit
string

Unit for quantity (e.g. GB, request, hour).

requests
object
total
number
chat
number
agent
number
composer
number
cmdk
number

Inline edit (e.g. Cursor Cmd+K).

tab_shown
number
tab_accepted
number
api_key
number
included
number
usage_based
number
bugbot
number
sessions
object
distinct
number
dispatch_turns
number

Cowork / background dispatch turns.

conversations
object
distinct
number
message_count
number
thinking_message_count
number
shared_viewed_count
number
turn_count
number
thread_count
number
code
object
lines_added
number
lines_removed
number
lines_accepted_added
number
lines_accepted_removed
number
applies
number
accepts
number
rejects
number
commits
number
pull_requests
number
tool_actions
object

Per-tool accept/reject counts (e.g. Claude Code).

file_extensions
object
apply_most_used
string
tab_most_used
string
tokens
object
input
number
output
number
cache_read
number
cache_write
number
cache_write_ephemeral_5m
number
cache_write_ephemeral_1h
number
total
number
tools
object
web_search_count
number
connectors_used_count
number
distinct_connectors_used_count
number
skills_used_count
number
distinct_skills_used_count
number
action_count
number
activity
object
is_active
boolean
max_mode
boolean
client_version
string
start_date
string · date-time

The start date for the usage data.

end_date
string · date-time

The end date for the usage data.

created_at
string · date-time

Date and time when the usage data metric was created.

updated_at
string · date-time

Date and time when the usage data metric was last updated.

surface
string

Specific product surface for this row when the source exposes a single surface, such as chat, claude_code, cowork, office_agent, composer, or api. Omit when the row is aggregate and no per-surface split exists.

remote_data
object

Raw data returned from the remote API call.