API Reference

Organizations

Billing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Top Up Organization Prepaid Balance

POST/v1/organizations/{organization_id}/billing/topup

Charge the card on file and credit the prepaid balance. A unique Idempotency-Key header is required; reuse it across retries so a timed-out top-up is not charged twice.

Path ParametersExpand Collapse

organization_id: string

Header ParametersExpand Collapse

"Idempotency-Key": string

Body ParametersJSONExpand Collapse

amount: string

Amount to charge and credit, in USD. Must be greater than 0, at most two decimal places, and at most 10000.

formatdecimal

ReturnsExpand Collapse

OrganizationBillingSummary 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”).

formatdecimal

effective_balance: string

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

formatdecimal

monthly_cost: string

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

formatdecimal

recharge_threshold_fraction: string

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

formatdecimal

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).

formatdate-time

runway_months: optional string

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

formatdecimal

Top Up Organization Prepaid Balance

HTTP

HTTP

TypeScript

Go

Terraform

CLI Tool

curl https://api.nirvanalabs.io/v1/organizations/$ORGANIZATION_ID/billing/topup \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "amount": "50.00"
        }'

200 example

{
  "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

200 example

{
  "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"
}