Sign in

v1

latestOpenAPI 3.0.02026-07-2628145109.6 KB
usage

Get usage costs

Retrieves the costs of a given group type, broken down by the given date modality.

get/organizations/{organization_id}/usage

Path parameters

organization_idstring uuid required

The UUID of the organization — this UUID is provided in the response on organization creation.

Query parameters

start_datestring date required

Start date, inclusive

end_datestring date required

End date, exclusive

group_by'job' | 'project' | 'user' required

QPU Usage grouping

Example:project

QPU Usage grouping

modality'daily' | 'weekly' | 'monthly' required

Report modality

Example:daily

Report modality

Response

Successfully retrieved a list of projects.

amount_totalnumber

The total cost amount for the given timeframe, in units given by usage_unit

group_type'job' | 'project' | 'user' required

QPU Usage grouping

job_countinteger

The total number of jobs run in the timeframe

modality'daily' | 'weekly' | 'monthly' required

Report modality

organizationstring uuid

UUID of an organization.

time_us_totalnumber

The total QPU time usage for the given timeframe, in microseconds

usage_fromstring date-time

Usage beginning RFC 3339 timestamp

usage_tostring date-time

Usage end RFC 3339 timestamp

usage_unitstring

The currency of the total and job cost amounts

Example response

{
  "amount_total": 151.31,
  "group_type": "project",
  "job_count": 514,
  "modality": "daily",
  "organization": "71d164e-6ebe-4126-8839-f1529bb01a00",
  "time_us_total": 1566154.312523,
  "usage_data": [
    {
      "amount": 1614.23,
      "from": "2023-07-01",
      "group_usages": [
        {
          "amount": 144.39,
          "group_id": "2bfd0fd5-5854-4916-917f-a907af586755",
          "group_name": "Project Jumping Lemming",
          "job_count": 9,
          "time_us": 1566154.312523
        }
      ],
      "job_count": 10,
      "time_us": 5143166.13413
    }
  ],
  "usage_from": "2025-10-01T00:00:00Z",
  "usage_to": "2025-11-01T00:00:00Z",
  "usage_unit": "USD"
}