Skip to navigation
API ReferenceUsage

Get Organization Usage

View as Markdown
Get current organization credit usage and balance.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

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.

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
blockedReasonslist of enums
Allowed values:
computedAtdatetime
RFC 3339 timestamp with a UTC offset.
creditsobject
cycleobject
isBlockedboolean
object"account.usage"
organizationIdstring

Errors

401
Unauthorized Error
403
Forbidden Error