Shared

ModelsExpand Collapse

CostQuote object { currency, monthly_total, priced_at, 3 more }

Cost quote returned by POST /cost. current_summary and updated_summary hold the org billing summary now and with this resource; omitted when the caller cannot view billing.

currency: string

Currency the quote is denominated in. Always “USD” in v1.

monthly_total: string

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

formatdecimal

priced_at: string

Timestamp the quote was priced at.

formatdate-time

usage_dimensions: array of object { dimension, dimension_display_name, monthly_amount, 2 more }

Priced rows, one per usage dimension emitted by the resource.

dimension: string

Usage dimension being priced (e.g. compute_vcpu, storage_abs_gb).

dimension_display_name: string

User-facing label for the dimension (e.g. “vCPU (hours)”).

monthly_amount: string

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

formatdecimal

quantity: number

Quantity of the dimension being priced.

unit_price: string

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

formatdecimal

current_summary: optional OrganizationBillingSummary { 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

updated_summary: optional OrganizationBillingSummary { 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

CostQuoteUpdate object { after, before, currency, 4 more }

Cost quote returned by PATCH /:id/cost: current-state quote, post-update quote, and signed diff. current_summary and updated_summary omitted when the caller cannot view billing.

after: object { monthly_total, usage_dimensions }

Quote for the proposed (post-update) resource state.

monthly_total: string

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

formatdecimal

usage_dimensions: array of object { dimension, dimension_display_name, monthly_amount, 2 more }

Priced rows, one per usage dimension emitted by the resource.

dimension: string

Usage dimension being priced (e.g. compute_vcpu, storage_abs_gb).

dimension_display_name: string

User-facing label for the dimension (e.g. “vCPU (hours)”).

monthly_amount: string

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

formatdecimal

quantity: number

Quantity of the dimension being priced.

unit_price: string

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

formatdecimal

before: object { monthly_total, usage_dimensions }

Quote for the proposed (post-update) resource state.

monthly_total: string

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

formatdecimal

usage_dimensions: array of object { dimension, dimension_display_name, monthly_amount, 2 more }

Priced rows, one per usage dimension emitted by the resource.

dimension: string

Usage dimension being priced (e.g. compute_vcpu, storage_abs_gb).

dimension_display_name: string

User-facing label for the dimension (e.g. “vCPU (hours)”).

monthly_amount: string

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

formatdecimal

quantity: number

Quantity of the dimension being priced.

unit_price: string

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

formatdecimal

currency: string

Currency the quote is denominated in. Always “USD” in v1.

diff: object { monthly_total_delta, usage_dimensions }

Per-dimension and total deltas: after minus before.

monthly_total_delta: string

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

formatdecimal

usage_dimensions: array of object { after, before, dimension, 2 more }

Per-dimension diff entries. Includes every dimension touched by the update.

after: object { monthly_amount, quantity, unit_price }

Priced row after the update. Always present.

monthly_amount: string

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

formatdecimal

quantity: number

unit_price: string

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

formatdecimal

before: object { monthly_amount, quantity, unit_price }

Priced row after the update. Always present.

monthly_amount: string

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

formatdecimal

quantity: number

unit_price: string

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

formatdecimal

dimension: string

Usage dimension being priced (e.g. compute_vcpu, storage_abs_gb).

dimension_display_name: string

User-facing label for the dimension (e.g. “vCPU (hours)”).

monthly_amount_delta: string

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

formatdecimal

priced_at: string

Timestamp the quote was priced at.

formatdate-time

current_summary: optional OrganizationBillingSummary { 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

updated_summary: optional OrganizationBillingSummary { 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

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

Pagination object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

RegionName = "us-sva-2"

Region the resource is in.

ResourceStatus = "pending" or "creating" or "updating" or 4 more

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

SourceIPRule object { allowed, blocked }

IP filter rules.

allowed: optional array of string

List of IPv4 CIDR addresses to allow.

blocked: optional array of string

List of IPv4 CIDR addresses to deny.

SourceIPRuleResponse object { allowed, blocked }

IP filter rules.

allowed: array of string

List of IPv4 CIDR addresses to allow.

blocked: array of string

List of IPv4 CIDR addresses to deny.