API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Shared

ModelsExpand Collapse

type CostQuote struct{…}

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.

MonthlyTotal string

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

formatdecimal

PricedAt Time

Timestamp the quote was priced at.

formatdate-time

UsageDimensions []CostQuoteUsageDimension

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

Dimension string

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

DimensionDisplayName string

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

MonthlyAmount string

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

formatdecimal

Quantity int64

Quantity of the dimension being priced.

UnitPrice string

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

formatdecimal

CurrentSummary OrganizationBillingSummaryOptional

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

DailyCost string

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

formatdecimal

EffectiveBalance string

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

formatdecimal

MonthlyCost string

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

formatdecimal

RechargeThresholdFraction string

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

formatdecimal

EstimatedNextChargeAt TimeOptional

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

formatdate-time

RunwayMonths stringOptional

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

formatdecimal

UpdatedSummary OrganizationBillingSummaryOptional

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

DailyCost string

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

formatdecimal

EffectiveBalance string

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

formatdecimal

MonthlyCost string

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

formatdecimal

RechargeThresholdFraction string

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

formatdecimal

EstimatedNextChargeAt TimeOptional

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

formatdate-time

RunwayMonths stringOptional

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

formatdecimal

type CostQuoteUpdate struct{…}

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 CostQuoteUpdateAfter

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

MonthlyTotal string

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

formatdecimal

UsageDimensions []CostQuoteUpdateAfterUsageDimension

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

Dimension string

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

DimensionDisplayName string

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

MonthlyAmount string

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

formatdecimal

Quantity int64

Quantity of the dimension being priced.

UnitPrice string

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

formatdecimal

Before CostQuoteUpdateBefore

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

MonthlyTotal string

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

formatdecimal

UsageDimensions []CostQuoteUpdateBeforeUsageDimension

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

Dimension string

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

DimensionDisplayName string

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

MonthlyAmount string

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

formatdecimal

Quantity int64

Quantity of the dimension being priced.

UnitPrice 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 CostQuoteUpdateDiff

Per-dimension and total deltas: after minus before.

MonthlyTotalDelta string

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

formatdecimal

UsageDimensions []CostQuoteUpdateDiffUsageDimension

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

After CostQuoteUpdateDiffUsageDimensionAfter

Priced row after the update. Always present.

MonthlyAmount string

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

formatdecimal

Quantity int64

UnitPrice string

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

formatdecimal

Before CostQuoteUpdateDiffUsageDimensionBefore

Priced row after the update. Always present.

MonthlyAmount string

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

formatdecimal

Quantity int64

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

DimensionDisplayName string

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

MonthlyAmountDelta string

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

formatdecimal

PricedAt Time

Timestamp the quote was priced at.

formatdate-time

CurrentSummary OrganizationBillingSummaryOptional

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

DailyCost string

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

formatdecimal

EffectiveBalance string

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

formatdecimal

MonthlyCost string

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

formatdecimal

RechargeThresholdFraction string

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

formatdecimal

EstimatedNextChargeAt TimeOptional

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

formatdate-time

RunwayMonths stringOptional

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

formatdecimal

UpdatedSummary OrganizationBillingSummaryOptional

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

DailyCost string

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

formatdecimal

EffectiveBalance string

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

formatdecimal

MonthlyCost string

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

formatdecimal

RechargeThresholdFraction string

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

formatdecimal

EstimatedNextChargeAt TimeOptional

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

formatdate-time

RunwayMonths stringOptional

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

formatdecimal

type OrganizationBillingSummary struct{…}

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

DailyCost string

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

formatdecimal

EffectiveBalance string

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

formatdecimal

MonthlyCost string

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

formatdecimal

RechargeThresholdFraction string

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

formatdecimal

EstimatedNextChargeAt TimeOptional

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

formatdate-time

RunwayMonths stringOptional

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

formatdecimal

type Pagination struct{…}

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

type RegionName string

Region the resource is in.

type ResourceStatus string

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

type SourceIPRule struct{…}

IP filter rules.

Allowed []stringOptional

List of IPv4 CIDR addresses to allow.

Blocked []stringOptional

List of IPv4 CIDR addresses to deny.

type SourceIPRuleResponse struct{…}

IP filter rules.

Allowed []string

List of IPv4 CIDR addresses to allow.

Blocked []string

List of IPv4 CIDR addresses to deny.