IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/org/billing/list-usage.md, instead of the current page.

Org / Billing /

List usage

Lists hourly usage entries.

Required permission

Account > Billing > General > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.
startTime
integer
The Unix timestamp to start from (inclusive).
endTime
integer
The Unix timestamp to end at (exclusive). Requires startTime.

Response body

{object}
Response object.

data
{object} required
Result data.

usage
[array]
An array of hourly usage entries, sorted by most recent first.

{object}

timestamp
number
The Unix timestamp of the billing hour.
paasUsage
{object}
The PaaS usage for this hour.

price
{object}

total
number
The total PaaS price, in cents.
cpu
number
The CPU usage price, in cents.
memory
number
The memory usage price, in cents.
storage
number
The storage usage price, in cents.
gpu
number
The GPU usage price, in cents.

byocUsage
{object}

price
{object}
The customer-level BYOC price total. Always reflects the full customer total, regardless of drill-down filters.

total
number
The total BYOC price, in cents.
vcpu
number
The vCPU usage price, in cents.
memory
number
The memory usage price, in cents.
gpuMemory
number
The GPU memory usage price, in cents.
cluster
number
The cluster usage price, in cents.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/billing/usage

GET /v1/teams/{teamId}/billing/usage

Example response

200 OK

A list of hourly usage entries.

JSON

{
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}