Skip to navigation
API ReferenceSpaces

Get a Space monthly spending cap

View as Markdown

Read this Space’s UTC calendar-month limit and accrued usage in USD cents. Both the organization and Space limits apply. Warning occurs once per month at 80%; at 100%, running work is stopped within at most one minute of additional usage.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

spaceIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
amountinteger or null0-100000000000
currency"USD"
object"spending_cap"
periodobject
scopeenum
Allowed values:
spaceIdstring or null
statusenum
Allowed values:
usageobject
warnAtPercentdouble

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error