Deployments.ai Docs
System

Show an organization's spend in a month, split by who paid

GET /v1/system/organizations/{organizationId}/spend · SDK getSystemOrganizationSpend · CLI deployments system spend

GET
/v1/system/organizations/{organizationId}/spend

Requires platform:admin. A machine service whose principal holds organization-read calls it with SigV4 at /v1/system/services/organizations/{organizationId}/spend.

Authorization

tenantJwt
headerAuthorizationBearer <token>

Tenant JWT carrying organization, project, and environment claims.

Path Parameters

organizationId*string

Organization whose spend to read.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Query Parameters

month?string

UTC calendar month as YYYY-MM, no later than the current month. Default: the current month.

Match^\d{4}-(?:0[1-9]|1[0-2])$

Response Body

SystemOrganizationSpendResponse

application/json
  1. response
asOf*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
month*string

The UTC calendar month, as YYYY-MM.

Match^\d{4}-(?:0[1-9]|1[0-2])$
operatorFundedUsdMicros*integer

Spend the installation paid for: model calls on its own provider keys and every other metered cost.

Range0 <= value
organizationFundedUsdMicros*integer

Model calls on the organization's own provider keys, at the catalog price.

Range0 <= value
periodStart*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
totalUsdMicros*integer

operatorFundedUsdMicros plus organizationFundedUsdMicros.

Range0 <= value
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
curl -X GET "https://example.com/v1/system/organizations/string/spend"
{  "asOf": "2019-08-24T14:15:22Z",  "month": "string",  "operatorFundedUsdMicros": 0,  "organizationFundedUsdMicros": 0,  "periodStart": "2019-08-24T14:15:22Z",  "totalUsdMicros": 0,  "organizationId": "string"}