compute

PUT `/v1/compute/spend-cap`

Set or clear the organisation's monthly limit on metered compute.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

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 PUT https://api.zinndigital.com/v1/compute/spend-cap \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "monthly_cap_minor": <object> }'

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

Details

When this month's metered hours reach the limit, the organisation's pay-by-the-hour machines are stopped within the hour, and started again within the hour of the limit being raised or the month turning. ⛔ A stopped machine still exists and is still rated by the hour; deleting it is what stops the billing.

Request body

Name	Type	Required	What it is
`monthly_cap_minor`	`object`	Yes	The new limit in minor units of the billing currency, or `null` to clear it.
`org_id`	`object`	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 metered compute. `null` = no limit.
`currency`	`string`	Yes	The organisation's billing currency.
`month_to_date_minor`	`integer`	Yes	What metered machines have rated so far this month, in `currency`.

Errors this endpoint can return

401 · 403 · 422 · 429