Skip to content

Ramp: List provider API keys and their estimated spend — response body — data item

List provider API keys and their estimated spend: response body, field data / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: List provider API keys and their estimated spend — response body — data item

FieldTypePresenceDescription and constraints
$objectRootA provider API key tracked for AI spend. Estimated cost applies to the requested period. All other fields reflect current metadata, not state as of the requested dates.
active_spend_limitJSONRequired within parent
active_spend_limit (anyOf 1)ModelAlternativeExpand List provider API keys and their estimated spend — response body — data / item / active_spend_limit / interval: annual, daily, monthly, quarterly, tertiary, total, weekly, yearly
Currently active configured spend limit. Its amount and reset cadence are independent of the requested historical dates. Null when the API key has no active spend limit.
active_spend_limit (anyOf 2)nullAlternative
estimated_costModelRequired within parentExpand Fetch a payment — response body — amount
Cost estimated by Ramp for usage attributed to the API key during the requested period. Zero when no usage was attributed.
Read only: true
external_idstringRequired within parentAPI key identifier assigned by the provider.
idstringRequired within parentUnique identifier of the API key.
Format: uuid
nameJSONRequired within parent
name (anyOf 1)stringAlternativeAPI key name reported by the provider.
name (anyOf 2)nullAlternative
ownerJSONRequired within parent
owner (anyOf 1)ModelAlternativeExpand List provider API keys and their estimated spend — response body — data item owner email, first name, id, last name
Owner identified by Ramp or the provider.
Read only: true
owner (anyOf 2)nullAlternative
providerstringRequired within parentProvider that issued the API key.
Known values: ANTHROPIC, OPENAI, RAMP
Read only: true
provider_created_atJSONRequired within parent
provider_created_at (anyOf 1)stringAlternativeDate and time the provider created the API key.
Format: date-time
provider_created_at (anyOf 2)nullAlternative
provider_key_hintJSONRequired within parent
provider_key_hint (anyOf 1)stringAlternativeRedacted API key hint reported by the provider.
provider_key_hint (anyOf 2)nullAlternative
provider_last_used_atJSONRequired within parent
provider_last_used_at (anyOf 1)stringAlternativeDate and time the provider last recorded usage.
Format: date-time
provider_last_used_at (anyOf 2)nullAlternative
statusJSONRequired within parent
status (anyOf 1)stringAlternativeCurrent API key status, when available from the provider.
Known values: active, expired, locked, terminated
status (anyOf 2)nullAlternative
synced_atstringRequired within parentDate and time Ramp last synchronized the API key.
Format: date-time
tagsarrayRequired within parentActive tags assigned to the API key.
tags[]ModelEach itemExpand List provider API keys and their estimated spend — response body — data item tags item

Referenced models: List provider API keys and their estimated spend — response body — data item owner email, first name, id, last name, List provider API keys and their estimated spend — response body — data item tags item, List provider API keys and their estimated spend — response body — data / item / active_spend_limit / interval: annual, daily, monthly, quarterly, tertiary, total, weekly, yearly, Fetch a payment — response body — amount

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.