Deployments.ai Docs
Tenancy

Show a month's spend split into operator-funded and organization-funded, with the operator-funded ceiling

GET /v1/organizations/{id}/spend · SDK getOrganizationSpend · CLI deployments org spend

GET
/v1/organizations/{id}/spend

Requires organizations:read.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

id*string
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])$

Header Parameters

x-deployments-organization*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

OrganizationSpendResponse

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}$
operatorFundedModelSpendCeiling*|

The organization's effective ceiling on operator-funded spend each month. It is the current ceiling, also for a past month.

curl -X GET "https://example.com/v1/organizations/string/spend" \  -H "x-deployments-organization: string"
{  "asOf": "2019-08-24T14:15:22Z",  "month": "string",  "operatorFundedUsdMicros": 0,  "organizationFundedUsdMicros": 0,  "periodStart": "2019-08-24T14:15:22Z",  "totalUsdMicros": 0,  "organizationId": "string",  "operatorFundedModelSpendCeiling": "unlimited"}