Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Query Parameters

scope_kind
enum<string>

Filter by scope kind Scope that determines which requests a pricing override applies to. The virtual_key* family is checked before the user* family during cost resolution, which is checked before the provider/global scopes; within a family, more identifiers present means a more specific match.

Available options:
global,
provider,
provider_key,
virtual_key,
virtual_key_provider,
virtual_key_provider_key,
user,
user_provider,
user_provider_key
user_id
string

Filter by user ID (for user* scopes)

virtual_key_id
string

Filter by virtual key ID (for virtual_key* scopes)

provider_id
string

Filter by provider ID

provider_key_id
string

Filter by provider key ID

Case-insensitive substring match against the pricing override name. A non-empty value switches the response to the paginated shape.

limit
integer

Maximum number of results to return. A non-empty limit, offset, or search value switches the response to the paginated shape.

Required range: x >= 0
offset
integer

Number of results to skip

Required range: x >= 0

Response

Successful response

When limit, offset, or search is supplied, count reflects the returned page while total_count reflects the full matching set. Otherwise (backward-compatible, non-paginated path) total_count equals count and limit/offset describe the full unpaged result.

pricing_overrides
object[]
count
integer

Number of overrides in this response

total_count
integer

Total number of overrides matching the filters

limit
integer

Page size used for this response

offset
integer

Offset used for this response