Get Box limits

GET

limits

Get Box limits

curl --request GET \
  --url https://ascii.dev/api/box/v1/limits \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ascii.dev/api/box/v1/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ascii.dev/api/box/v1/limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ascii.dev/api/box/v1/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/limits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "type": "limits.info",
  "canStart": true,
  "activeBoxes": 1,
  "activeStates": [
    "provisioned",
    "cloning",
    "ready",
    "idle",
    "running"
  ],
  "boxPlanKey": "box_20",
  "boxPlanDollars": 20,
  "maxActiveBoxes": 100,
  "maxCreationRequestsPerMinute": 10,
  "maxCreationRequestsPerDay": null,
  "startLimits": {
    "perMinute": 10,
    "perHour": 50,
    "perDay": 150
  },
  "starts": {
    "unlimited": false,
    "minute": {
      "limit": 10,
      "used": 3,
      "remaining": 7
    },
    "hour": {
      "limit": 50,
      "used": 12,
      "remaining": 38
    },
    "day": {
      "limit": 150,
      "used": 47,
      "remaining": 103
    }
  },
  "billingStatus": "active",
  "creditBalanceSeconds": 7200,
  "creditBalanceHours": 2,
  "packBalanceSeconds": 500000,
  "packBalanceHours": 138.89,
  "packBalanceDollars": 5
}

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

Authorizations

Authorization

string

header

required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Headers

X-Box-Org

string

Same as the org query parameter. Query wins when both are set.

Query Parameters

org

string

Billing wallet for this request. A team id you belong to reads that team's limits / bills a create to that team. Your own account id is personal. Boxes, snapshots, and environments stay creator-private.

teamId

string

Legacy alias for org. Takes precedence over org / X-Box-Org when set.

Response

Current creation and concurrent-box limits.

boolean

required

Example:

true

type

string

required

Stable success envelope discriminator added by v1.

canStart

boolean

required

Whether the authenticated account can create or operate boxes right now.

activeBoxes

integer

required

maxActiveBoxes

integer

required

billingStatus

string

required

Account access state returned by the current backend. Billing endpoints are not part of v1.

accessTier

string

Example:

"trial"

blockedReason

string | null

currentLimits

object

Show child attributes

standardLimits

object

Show child attributes

trialLimits

object

Show child attributes

upgradeEffects

object

checkoutRequired

boolean

startBlockedReason

string | null

contactMessage

string | null

activeStates

string[]

maxCreationRequestsPerMinute

integer

maxCreationRequestsPerDay

integer | null

startLimits

object | null

Plan caps for machine starts. Null on unlimited accounts. Create, fork and resume each count as one start.

Show child attributes

starts

object

Remaining machine starts in the rolling minute, hour and day windows. Null windows mean the account is unlimited.

Show child attributes

creditBalanceHours

number | null

Remaining machine time in hours (creditBalanceSeconds / 3600). Null on unlimited accounts.

packBalanceHours

number

Remaining purchased credit packs in hours.

packBalanceDollars

number

Remaining purchased credit packs in dollars.

hasPaymentHistory

boolean

package

object

subscriptionQuotaSeconds

integer

subscriptionRemainingSeconds

integer

packBalanceSeconds

integer

creditPurchasedSeconds

integer

creditUsedSeconds

integer

liveUsageSeconds

integer

creditSecondsPerDollar

integer

subscriptionStatus

string | null

subscriptionCancelAtPeriodEnd

boolean

hasSubscription

boolean

subscriptionTrialEndsAt

string<date-time> | null

subscriptionCurrentPeriodEnd

string<date-time> | null

creditBalanceSeconds

integer

teamId

string

Present when limits were read for a team wallet (?teamId=, ?org=, or X-Box-Org).

teamRole

string

Caller's role on that team when teamId is present.

Get Box limits

curl --request GET \
  --url https://ascii.dev/api/box/v1/limits \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://ascii.dev/api/box/v1/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ascii.dev/api/box/v1/limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ascii.dev/api/box/v1/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/limits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "type": "limits.info",
  "canStart": true,
  "activeBoxes": 1,
  "activeStates": [
    "provisioned",
    "cloning",
    "ready",
    "idle",
    "running"
  ],
  "boxPlanKey": "box_20",
  "boxPlanDollars": 20,
  "maxActiveBoxes": 100,
  "maxCreationRequestsPerMinute": 10,
  "maxCreationRequestsPerDay": null,
  "startLimits": {
    "perMinute": 10,
    "perHour": 50,
    "perDay": 150
  },
  "starts": {
    "unlimited": false,
    "minute": {
      "limit": 10,
      "used": 3,
      "remaining": 7
    },
    "hour": {
      "limit": 50,
      "used": 12,
      "remaining": 38
    },
    "day": {
      "limit": 150,
      "used": 47,
      "remaining": 103
    }
  },
  "billingStatus": "active",
  "creditBalanceSeconds": 7200,
  "creditBalanceHours": 2,
  "packBalanceSeconds": 500000,
  "packBalanceHours": 138.89,
  "packBalanceDollars": 5
}

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}