Summarize billing records for an NGC organization

GET

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

Returns aggregate counts and total billed compute hours for billing records that match the same filters and period overlap as the list endpoint. The query object echoes sent query parameters.

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.

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.

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.

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

querymap from strings to strings

Echo of the query parameters used to filter billing records.

summaryobject

Aggregated billing metrics for the filtered billing records.

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error