Skip to content
Docs

Get Organization Billing Summary

$ nirvana organizations:billing summary
GET/v1/organizations/{organization_id}/billing/summary

Get the organization’s billing summary: effective balance, monthly and daily run-rate cost, runway, and the projected next-recharge date. Costs are run-rate projections.

ParametersExpand Collapse
--organization-id: string

Organization ID

ReturnsExpand Collapse
organization_billing_summary: object { daily_cost, effective_balance, monthly_cost, 3 more }

Forward-looking billing summary for an organization. All costs are run-rate projections from the organization’s current active usage (”≈ $X/mo at current usage”).

daily_cost: string

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

effective_balance: string

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

monthly_cost: string

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

recharge_threshold_fraction: string

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

estimated_next_charge_at: optional string

Projected date the balance reaches the recharge threshold at the current run-rate. Null when there is no active usage (never charges).

runway_months: optional string

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

Get Organization Billing Summary

nirvana organizations:billing summary \
  --api-key 'My API Key' \
  --organization-id organization_id
{
  "daily_cost": "-69125",
  "effective_balance": "-69125",
  "monthly_cost": "-69125",
  "recharge_threshold_fraction": "-69125",
  "estimated_next_charge_at": "2025-01-01T00:00:00Z",
  "runway_months": "-69125"
}
Returns Examples
{
  "daily_cost": "-69125",
  "effective_balance": "-69125",
  "monthly_cost": "-69125",
  "recharge_threshold_fraction": "-69125",
  "estimated_next_charge_at": "2025-01-01T00:00:00Z",
  "runway_months": "-69125"
}