Skip to main content

CksEnvironmentQuote

Pricing quote for a proposed environment selection plus the org wallet balance, used to gate createEnvironment. All *Cents fields are in minor currency units (cents).

type CksEnvironmentQuote {
  datacenter: String!
  databaseFlavor: String!
  gameApiFlavor: String!
  udpBuddyFlavor: String!
  caddyFlavor: String!
  gameApiMinServers: Int!
  gameApiMaxServers: Int!
  udpBuddyMinServers: Int!
  udpBuddyMaxServers: Int!
  loadBalancerCount: Int!
  environmentClass: String!
  singleBoxFlavor: String
  hourlyCostCents: BigInt!
  firstDayReserveCents: BigInt!
  walletBalanceCents: BigInt!
  availableBalanceCents: BigInt!
  currency: String!
  canCreate: Boolean!
}

Fields​

CksEnvironmentQuote.datacenter ● String! non-null scalar​

CksEnvironmentQuote.databaseFlavor ● String! non-null scalar​

CksEnvironmentQuote.gameApiFlavor ● String! non-null scalar​

CksEnvironmentQuote.udpBuddyFlavor ● String! non-null scalar​

CksEnvironmentQuote.caddyFlavor ● String! non-null scalar​

CksEnvironmentQuote.gameApiMinServers ● Int! non-null scalar​

CksEnvironmentQuote.gameApiMaxServers ● Int! non-null scalar​

CksEnvironmentQuote.udpBuddyMinServers ● Int! non-null scalar​

CksEnvironmentQuote.udpBuddyMaxServers ● Int! non-null scalar​

CksEnvironmentQuote.loadBalancerCount ● Int! non-null scalar​

CksEnvironmentQuote.environmentClass ● String! non-null scalar​

'dedicated' (multi-VM) or 'dev_single' (one dev-only VM).

CksEnvironmentQuote.singleBoxFlavor ● String scalar​

Single VM flavor when environmentClass = 'dev_single'.

CksEnvironmentQuote.hourlyCostCents ● BigInt! non-null scalar​

Total hourly price of the full selection, in cents.

CksEnvironmentQuote.firstDayReserveCents ● BigInt! non-null scalar​

Up-front wallet reserve required to create (≈ first day of runtime), in cents.

CksEnvironmentQuote.walletBalanceCents ● BigInt! non-null scalar​

Org wallet balance, in cents.

CksEnvironmentQuote.availableBalanceCents ● BigInt! non-null scalar​

Wallet balance still available after existing reservations, in cents. Compared against firstDayReserveCents.

CksEnvironmentQuote.currency ● String! non-null scalar​

ISO-4217 currency of the *Cents fields, e.g. 'USD'.

CksEnvironmentQuote.canCreate ● Boolean! non-null scalar​

True when availableBalanceCents ≥ firstDayReserveCents, or when AUTO_BILLING_PAID_PROVISIONING_ENABLED is true and auto-billing is enabled with a saved payment method and enough period headroom to cover the shortfall. createEnvironment may auto-recharge before provisioning when the wallet is short but billing-ready.

Returned By​

environmentQuote query