Skip to content
Nirvana LabsNirvana Labs API
Docs
    API Reference
    Organizations
    Billing

    Top Up Organization Prepaid Balance

    $ nirvana organizations:billing top-up
    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.

    ParametersExpand Collapse
    --organization-id: string

    Path param: Organization ID

    --amount: string

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

    --idempotency-key: string

    Header param: Unique idempotency key scoping the charge; reuse the same value across retries so a timed-out top-up is not charged twice

    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_days: 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”).

    Top Up Organization Prepaid Balance

    nirvana organizations:billing top-up \
  --api-key 'My API Key' \
  --organization-id organization_id \
  --amount 50.00 \
  --idempotency-key Idempotency-Key
    {
  "daily_cost": "-69125",
  "effective_balance": "-69125",
  "monthly_cost": "-69125",
  "recharge_threshold_days": "-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_days": "-69125",
  "estimated_next_charge_at": "2025-01-01T00:00:00Z",
  "runway_months": "-69125"
}