Skip to main content
POST
Simulate gateway budgets

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
user
string

User email to simulate as.

Example:

"alice@team-1.com"

virtual_account
string

Virtual account slug to simulate as. Use this instead of user for virtual-account budgets.

Example:

"my-virtual-account"

team
string

Single team to simulate membership of. Use teams to pass multiple teams.

Example:

"engineering"

teams
string[]

All teams the simulated user belongs to. Merged with team when both are provided.

Example:
model
string

Model to simulate.

Example:

"openai/gpt-4o"

metadata
object

Request metadata key/value pairs to simulate.

Example:

Response

200 - application/json

The budgets matching the selection.

matched
BudgetUsageEntry · object[]
required

Budgets that apply, with current usage.