API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Organizations

Create Organization

$ nirvana organizations create

POST/v1/organizations

Get Organization Details

$ nirvana organizations get

GET/v1/organizations/{organization_id}

Update Organization

$ nirvana organizations update

PATCH/v1/organizations/{organization_id}

List Organizations

$ nirvana organizations list

GET/v1/organizations

Leave Organization

$ nirvana organizations leave

POST/v1/organizations/{organization_id}/leave

ModelsExpand Collapse

organization: object { id, billing_email, billing_state, 11 more }

Organization response.

id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

billing_state: "unfunded" or "active" or "requires_action" or 2 more

Organization billing lifecycle state.

"unfunded"

"active"

"requires_action"

"suspended"

"closed"

billing_state_since: string

When the organization entered its current billing state.

charging_model: "manual" or "prepaid"

How the organization is charged for resource usage.

"manual"

"prepaid"

created_at: string

When the Organization was created.

domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

type: "personal" or "company"

Organization type.

"personal"

"company"

updated_at: string

When the Organization was updated.

auth_id: optional string

Authentication provider organization ID.

organization_domain: object { id, domain, verified }

Organization domain details.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

organization_list: object { items, pagination }

items: array of Organization { id, billing_email, billing_state, 11 more }

id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

billing_state: "unfunded" or "active" or "requires_action" or 2 more

Organization billing lifecycle state.

"unfunded"

"active"

"requires_action"

"suspended"

"closed"

billing_state_since: string

When the organization entered its current billing state.

charging_model: "manual" or "prepaid"

How the organization is charged for resource usage.

"manual"

"prepaid"

created_at: string

When the Organization was created.

domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

type: "personal" or "company"

Organization type.

"personal"

"company"

updated_at: string

When the Organization was updated.

auth_id: optional string

Authentication provider organization ID.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

organization_services: object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

organization_type: "personal" or "company"

Organization type.

"personal"

"company"

OrganizationsMemberships

Get Organization Membership

$ nirvana organizations:memberships get

GET/v1/organizations/{organization_id}/memberships/{membership_id}

List Organization Memberships

$ nirvana organizations:memberships list

GET/v1/organizations/{organization_id}/memberships

ModelsExpand Collapse

organization_membership: object { id, created_at, organization_id, 3 more }

Organization membership details.

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "member"

Role of the user in the organization.

"owner"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

organization_membership_list: object { items, pagination }

items: array of OrganizationMembership { id, created_at, organization_id, 3 more }

id: string

Membership ID.

created_at: string

When the membership was created.

organization_id: string

Organization ID.

role: "owner" or "member"

Role of the user in the organization.

"owner"

"member"

updated_at: string

When the membership was updated.

user_id: string

User ID.

pagination: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

OrganizationsAddress

Create Organization Address

$ nirvana organizations:address create

POST/v1/organizations/{organization_id}/address

Get Organization Address

$ nirvana organizations:address get

GET/v1/organizations/{organization_id}/address

Update Organization Address

$ nirvana organizations:address update

PATCH/v1/organizations/{organization_id}/address

ModelsExpand Collapse

organization_address: object { id, city, country, 9 more }

Organization address details.

id: string

Address ID.

city: string

City or locality.

country: string

Two-letter ISO 3166-1 alpha-2 country code.

created_at: string

When the address was created.

line1: string

First line of the street address.

line2: string

Second line of the street address. Null when not provided.

organization_id: string

Organization ID the address belongs to.

postal_code: string

Postal or ZIP code.

state: string

State, province, or region. Null when not provided.

tax_id: string

Tax identification number. Null when not provided.

tax_id_type: string

Type of the tax identification number. Null when not provided.

updated_at: string

When the address was updated.

OrganizationsBilling

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, 5 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.

funding_purpose: optional "first_charge" or "auto_recharge" or "manual_top_up" or "manual_recharge"

Funding flow that produced this entry, for a grant: “first_charge”, “auto_recharge”, “manual_top_up”, or “manual_recharge”. Null for adjustments.

"first_charge"

"auto_recharge"

"manual_top_up"

"manual_recharge"

receipt_url: optional string

Link to the hosted receipt for the payment behind this entry, when one is available. Present for prepaid credits funded by a card charge; absent for manual adjustments and while a payment’s receipt is still being finalized.

billing_history_entry_list: object { items, pagination }

items: array of BillingHistoryEntry { id, amount, created_at, 5 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.

funding_purpose: optional "first_charge" or "auto_recharge" or "manual_top_up" or "manual_recharge"

Funding flow that produced this entry, for a grant: “first_charge”, “auto_recharge”, “manual_top_up”, or “manual_recharge”. Null for adjustments.

"first_charge"

"auto_recharge"

"manual_top_up"

"manual_recharge"

receipt_url: optional string

Link to the hosted receipt for the payment behind this entry, when one is available. Present for prepaid credits funded by a card charge; absent for manual adjustments and while a payment’s receipt is still being finalized.

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

organization_usage_statement: object { currency, month, projects, total }

Itemized usage statement for a billing month: consumption grouped by project, resource type, and dimension. Costs are recorded at consumption time, not re-priced.

currency: string

ISO 4217 currency code.

month: string

Billing month the statement covers, as YYYY-MM (UTC).

projects: array of StatementProject { project_id, project_name, resource_types, subtotal }

One entry per project with consumption in the month, ordered by name.

project_id: string

Project identifier.

project_name: string

Human-readable project name.

resource_types: array of StatementResourceType { items, resource_type, subtotal }

Consumption grouped by resource type.

items: array of StatementLineItem { children, cost, dimension, 3 more }

Top-level metered dimensions; a dimension expanded into components carries them in children.

children: array of StatementLineItemLeaf { cost, dimension, display_name, 2 more }

Component dimensions nested under this one (e.g. vCPU and memory under an instance type). Empty for a leaf.

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_vcpu”, “compute_memory_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: string

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

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_n1_standard_8”, “storage_abs_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: optional string

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

resource_type: string

Resource type the line items belong to (e.g. “vm”, “volume”, “nks_node_pool”).

subtotal: string

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

subtotal: string

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

total: string

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

statement_line_item: object { children, cost, dimension, 3 more }

A top-level metered dimension. Heads nest components as children (cost is the subtotal, unit_price null); standalone dimensions carry a unit price and an empty children array.

children: array of StatementLineItemLeaf { cost, dimension, display_name, 2 more }

Component dimensions nested under this one (e.g. vCPU and memory under an instance type). Empty for a leaf.

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_vcpu”, “compute_memory_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: string

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

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_n1_standard_8”, “storage_abs_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: optional string

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

statement_line_item_leaf: object { cost, dimension, display_name, 2 more }

A priced dimension line: a component nested under a head, or one rate segment of a dimension whose price changed mid-period.

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_vcpu”, “compute_memory_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: string

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

statement_project: object { project_id, project_name, resource_types, subtotal }

A single project’s consumption within a usage statement.

project_id: string

Project identifier.

project_name: string

Human-readable project name.

resource_types: array of StatementResourceType { items, resource_type, subtotal }

Consumption grouped by resource type.

items: array of StatementLineItem { children, cost, dimension, 3 more }

Top-level metered dimensions; a dimension expanded into components carries them in children.

children: array of StatementLineItemLeaf { cost, dimension, display_name, 2 more }

Component dimensions nested under this one (e.g. vCPU and memory under an instance type). Empty for a leaf.

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_vcpu”, “compute_memory_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: string

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

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_n1_standard_8”, “storage_abs_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: optional string

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

resource_type: string

Resource type the line items belong to (e.g. “vm”, “volume”, “nks_node_pool”).

subtotal: string

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

subtotal: string

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

statement_resource_type: object { items, resource_type, subtotal }

Consumption for one resource type within a project (e.g. every VM, every volume).

items: array of StatementLineItem { children, cost, dimension, 3 more }

Top-level metered dimensions; a dimension expanded into components carries them in children.

children: array of StatementLineItemLeaf { cost, dimension, display_name, 2 more }

Component dimensions nested under this one (e.g. vCPU and memory under an instance type). Empty for a leaf.

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_vcpu”, “compute_memory_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: string

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

cost: string

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

dimension: string

Metered dimension identifier (e.g. “compute_n1_standard_8”, “storage_abs_gb”).

display_name: string

Human-readable label for the dimension.

quantity_hours: string

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

unit_price: optional string

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

resource_type: string

Resource type the line items belong to (e.g. “vm”, “volume”, “nks_node_pool”).

subtotal: string

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

OrganizationsBillingRecharge Policy

ModelsExpand Collapse

automatic_policy_args: object { fixed, runway_days, monthly_cap }

PolicyArgs carries the threshold parameters. Required when policy is “automatic”; must be omitted when policy is “manual”.

fixed: string

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

runway_days: string

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

monthly_cap: optional string

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

organization_recharge_policy: object { policy, policy_args, policy_since }

An organization’s current recharge policy. policy_args is null for a manual policy.

policy: "manual" or "automatic"

Policy is the top-up mode.

"manual"

"automatic"

policy_args: object { fixed, runway_days, monthly_cap }

PolicyArgs carries the threshold parameters. Required when policy is “automatic”; must be omitted when policy is “manual”.

fixed: string

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

runway_days: string

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

monthly_cap: optional string

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

policy_since: string

PolicySince is when the policy currently in force took effect. Any change moves it, including an edit to the threshold parameters of an automatic policy.

recharge_policy_mode: "manual" or "automatic"

Policy is the top-up mode.

"manual"

"automatic"