Billing

Get Organization Billing Summary

$ nirvana organizations:billing summary

GET/v1/organizations/{organization_id}/billing/summary

ModelsExpand Collapse

billing_history_entry: object { id, amount, created_at, 3 more }

A single billing history line item: a prepaid credit or a manual adjustment.

id: string

Unique identifier for the entry.

amount: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

created_at: string

When the entry was recorded.

currency: string

ISO 4217 currency code.

type: "grant" or "adjustment"

Kind of entry.

"grant"

"adjustment"

description: optional string

Human-readable note describing the entry, when available.

billing_history_entry_list: object { items, pagination }

items: array of BillingHistoryEntry { id, amount, created_at, 3 more }

id: string

Unique identifier for the entry.

amount: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

created_at: string

When the entry was recorded.

currency: string

ISO 4217 currency code.

type: "grant" or "adjustment"

Kind of entry.

"grant"

"adjustment"

description: optional string

Human-readable note describing the entry, when available.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

billing_history_entry_type: "grant" or "adjustment"

Kind of entry.

"grant"

"adjustment"

daily_cost_point: object { cost, date }

Total usage cost for a single UTC day.

cost: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

date: string

UTC calendar day (YYYY-MM-DD).

organization_daily_cost: object { currency, days, from, to }

Daily usage cost over a date range: one entry per UTC day (zero on idle days), summing open and closed resources. Suitable for a daily cost bar chart.

currency: string

ISO 4217 currency code.

days: array of DailyCostPoint { cost, date }

One entry per UTC day in the range, oldest first.

cost: string

Arbitrary-precision decimal serialized as a string (e.g. “58.40”).

date: string

UTC calendar day (YYYY-MM-DD).

from: string

Inclusive start of the range, as a UTC calendar day (YYYY-MM-DD).

to: string

Inclusive end of the range, as a UTC calendar day (YYYY-MM-DD).