compute
GET /v1/compute/servers/{serverId}/usage
One server's metered hours, charges and ledger check for a month.
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.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/servers/{serverId}/usage \
-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 |
|---|---|---|---|
serverId (path) | Uuid | Yes | The server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine. |
period (query) | string | No | The month, YYYY-MM (UTC). Defaults to the current month. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
period | string | Yes | — |
hours | integer | Yes | Started hours rated in the month. |
rated_minor | integer | Yes | Whole minor units rated. A sub-unit remainder is carried, never rounded up. |
settled_minor | integer | Yes | Net of tax |
unsettled_minor | integer | Yes | Rated and not yet paid. |
currency | string | Yes | — |
settlements | ComputeUsageSettlement[] | Yes | — |
reconciles | boolean | Yes | Whether hours, settlements, their orders and the balance draws all agree. It is computed from four independently written records, never a figure against itself. |
discrepancies | string[] | Yes | Every disagreement found, in words. Empty when reconciles is true. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429