Get machine cost

GET

sandboxes

{id}

cost

curl --request GET \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID/cost" \
  --header "X-API-Key: $BEAD_API_KEY"

# sandbox is returned by Sandbox.create or Sandbox.connect.
print(sandbox.cost())

// sandbox is returned by Sandbox.create or Sandbox.connect.
console.log(await sandbox.cost());

{
  "credit_units": 123,
  "credit_units_per_usd": 123,
  "start_credit_units": 123,
  "priced_intervals": 123,
  "observed_intervals": 123,
  "uncertain_intervals": 123,
  "price_version": "<string>",
  "metered_cost_numerator": "<string>",
  "metered_cost_denominator": "<string>",
  "metered_cost": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "partial": true
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

Parameters

string

required

Machine identifier returned by creation.

curl --request GET \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID/cost" \
  --header "X-API-Key: $BEAD_API_KEY"

# sandbox is returned by Sandbox.create or Sandbox.connect.
print(sandbox.cost())

// sandbox is returned by Sandbox.create or Sandbox.connect.
console.log(await sandbox.cost());

Response

200

Current credit and metering totals for this machine.

integer

required

Total credit units debited for the machine and its starts.

integer

required

Number of credit units in one USD.

integer

required

Credit units debited for machine start admission.

integer

required

Usage intervals with a price.

integer

required

Observed usage intervals.

integer

required

Usage intervals with uncertain measurements.

string

required

Tariff version used for this cost view.

string

required

Exact metered charge numerator.

string

required

Exact metered charge denominator.

object

required

Exact charge with a decimal USD display value.

Show Properties

string

required

USD amount rendered to twelve decimal places.

string

required

Exact charge numerator in credit units; encoded as a string to preserve precision.

string

required

Denominator for the exact charge numerator, before conversion to USD.

boolean

required

True when usage is absent, unpriced, or uncertain.

Errors

Status	Meaning
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
404	The requested resource does not exist or is outside your organization.
429	Request or resource admission limit exceeded (`admission_limit`). Follow limit.next_action and Retry-After when present.
503	Service or persistence is temporarily unavailable.

curl --request GET \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID/cost" \
  --header "X-API-Key: $BEAD_API_KEY"

# sandbox is returned by Sandbox.create or Sandbox.connect.
print(sandbox.cost())

// sandbox is returned by Sandbox.create or Sandbox.connect.
console.log(await sandbox.cost());

{
  "credit_units": 123,
  "credit_units_per_usd": 123,
  "start_credit_units": 123,
  "priced_intervals": 123,
  "observed_intervals": 123,
  "uncertain_intervals": 123,
  "price_version": "<string>",
  "metered_cost_numerator": "<string>",
  "metered_cost_denominator": "<string>",
  "metered_cost": {
    "usd": "<string>",
    "numerator": "<string>",
    "denominator": "<string>"
  },
  "partial": true
}

Start here

Endpoints

Get machine cost

Authentication

Parameters

Response

200

Errors

​Authentication

​Parameters

​Response

​200

​Errors

Authentication

Parameters

Response

200

Errors