compute

GET `/v1/compute/spend-cap`

Read the organisation's monthly limit on metered compute.

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/compute/spend-cap \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Parameters

Name	Type	Required	What it is
`org_id (query)`	`string`	No	Required only when the caller belongs to more than one organisation.

Response

Name	Type	Required	What it is
`monthly_cap_minor`	`object`	Yes	The organisation's monthly limit on server usage (pay-by-the-hour hours plus traffic over a server's allowance). `null` = no limit.
`currency`	`string`	Yes	The organisation's billing currency.
`month_to_date_minor`	`integer`	Yes	What the organisation's servers have used so far this month, in `currency` — the figure the limit is compared against. Equals `metered_minor` + `bandwidth_overage_minor`.
`metered_minor`	`integer`	Yes	Pay-by-the-hour usage rated so far this month, in `currency`.
`bandwidth_overage_minor`	`integer`	Yes	Traffic over the servers' monthly allowances so far this month, in `currency` (accrued, whether or not a charge has been taken for it yet).

Errors this endpoint can return

401 · 403 · 422 · 429