List billing records for an NGC organization

GET

https://api.dsx-air.nvidia.com/api/v3/billing-records/

GET

/api/v3/billing-records/

curl https://api.dsx-air.nvidia.com/api/v3/billing-records/ \
     -H "Authorization: Bearer <token>"

{
  "count": 123,
  "results": [
    {
      "id": "string",
      "created": "2024-01-15T09:30:00Z",
      "modified": "2024-01-15T09:30:00Z",
      "org_id": "string",
      "org_display_name": "string",
      "org_nca_id": "string",
      "ngc_org_name": "string",
      "org_is_banned": true,
      "simulation_uuid": "string",
      "sim_cpu": 1,
      "sim_memory": 1,
      "sim_storage": 1,
      "sim_compute_hours_rate": 1.1,
      "sim_compute_hours_consumed": 1.1,
      "sim_compute_hours_consumed_for_period": 1.1,
      "billing_started_at": "2024-01-15T09:30:00Z",
      "sim_name": "string",
      "sim_creator": "string",
      "sim_owner": "string",
      "run_id": "string",
      "billing_ended_at": "2024-01-15T09:30:00Z",
      "fleet_id": "string",
      "fleet_name": "string"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Review detailed information about billing usage data over a given time period for running simulations. The actual compute hours consumed per simulation during the specified period will be reflected in the sim_compute_hours_consumed_for_period field, and the total compute hours consumed for the entire run of that simulation will be reflected in the sim_compute_hours_consumed field.

Required role: air_org_admin

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

billing_ended_atdatetimeOptional

Filter by when this billing window ended. A date-only value (YYYY-MM-DD) matches all records that ended on that calendar day. A full datetime matches that exact timestamp.

billing_ended_at_isnullbooleanOptional

Filter by whether the billing record has an end time.

billing_started_atdatetimeOptional

Filter by when this billing window began. A date-only value (YYYY-MM-DD) matches all records that began on that calendar day. A full datetime matches that exact timestamp.

createddatetimeOptional

Filter by when the record was created. A date-only value (YYYY-MM-DD) matches all records on that calendar day. A full datetime matches that exact timestamp.

fleet_idstringOptionalformat: "uuid"

Filter by the fleet ID running the sim.

fleet_namestringOptional

Filter by the fleet name running the sim.

idstringOptionalformat: "uuid"

Filter by billing record ID.

limitintegerOptional

Number of results to return per page.

modifieddatetimeOptional

Filter by when the record was last modified. A date-only value (YYYY-MM-DD) matches all records on that calendar day. A full datetime matches that exact timestamp.

ngc_org_namestringOptional

Filter by the NGC organization name of the billed organization.

offsetintegerOptional

The initial index from which to return the results.

orderingenumOptional

Order objects by field. Prefix with - for descending order.

org_is_bannedbooleanOptional

Filter by whether the organization is banned.

period_enddatetimeOptional

Specify the end of a window to filter billing records. Example: 2026-01-31T23:59:59Z

period_startdatetimeOptional

Specify the start of a window to filter billing records. Example: 2026-01-01T00:00:00Z

run_idstringOptionalformat: "uuid"

Filter by the run ID the billing record corresponds to.

searchstringOptional

Search by sim_name, simulation_uuid, sim_owner, billing_started_at, billing_ended_at, sim_compute_hours_rate, sim_compute_hours_consumed, sim_compute_hours_consumed_for_period, sim_cpu, sim_memory, or sim_storage.

sim_compute_hours_consumeddoubleOptional

Filter by total compute hours consumed.

sim_compute_hours_consumed_for_perioddoubleOptional

Filter by compute hours consumed for the requested period.

sim_compute_hours_ratefloatOptional

Filter by compute-hours rate applied while the sim was running.

sim_cpuintegerOptional

Filter by total CPU allocated across all nodes while the sim was running.

sim_creatorstringOptional

Filter by creator of the simulation.

sim_memoryintegerOptional

Filter by total memory (MiB) allocated across all nodes while the sim was running.

sim_namestringOptional

Filter by simulation name.

sim_ownerstringOptional

Filter by owner of the simulation. Same as the creator unless the sim is assigned to someone else.

sim_storageintegerOptional

Filter by total storage (GB) allocated across all nodes while the sim was running.

simulation_uuidstringOptionalformat: "uuid"

Filter by simulation ID.

Response

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error