Skip to main content
PATCH
Update spend settings

Authorizations

Authorization
string
header
required

Send Authorization: Bearer YOUR_API_KEY. The key resolves to a single organization.

Body

application/json
monthlyCapUsd
number | null

Monthly cap in USD: 0, or at least 0.01. Null: the plan default.

Required range: 0 <= x <= 1000000
approvalThresholdUsd
number | null

Per-run approval threshold in USD: 0 (every run needs approval), or at least 0.01. Null: off.

Required range: 0 <= x <= 1000000

Response

Successful response.

Month-to-date benchmark spend against the cap and the included credit, with open approval requests.

month
string
required

The UTC calendar month, YYYY-MM.

plan
string
required
paid
boolean
required

Whether the plan can be billed past the included credit.

monthToDateUsd
number
required

Billed this month by benchmark runs, plus what queued and running runs have reserved.

settledUsd
number
required

Billed so far this month.

reservedUsd
number
required

Estimated cost still reserved by queued and running runs.

monthlyCapUsd
number | null
required

The cap in effect, or null for no cap.

monthlyCapSource
enum<string>
required

Whether an owner set the cap or it is the plan default.

Available options:
owner,
plan
planDefaultMonthlyCapUsd
number | null
required

USD, to micro-dollar precision (up to 6 decimals), so sub-cent spend such as a Judge try is visible.

capRemainingUsd
number | null
required

Cap minus month to date (never below 0), or null for no cap.

approvalThresholdUsd
number | null
required

Runs estimated above this need an owner's approval. Null: off.

freeCreditUsd
number
required

Platform credit included each month (Free plan).

creditRemainingUsd
number
required

USD, to micro-dollar precision (up to 6 decimals), so sub-cent spend such as a Judge try is visible.

pendingApprovals
object[]
required

Open approval requests across the organization, oldest first.

canEditSettings
boolean
required

Whether the caller is an owner and may change the cap and threshold.

{key}
any