Skip to main content
GET
/
limits
Get Box limits
curl --request GET \
  --url https://ascii.dev/api/box/v1/limits \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "type": "limits.info",
  "canStart": true,
  "activeBoxes": 1,
  "activeStates": [
    "provisioned",
    "cloning",
    "ready",
    "idle",
    "running"
  ],
  "maxActiveBoxes": 100,
  "maxCreationRequestsPerMinute": 20,
  "maxCreationRequestsPerDay": null,
  "billingStatus": "active",
  "creditBalanceSeconds": 7200
}

Authorizations

​
Authorization
string
header
required

Box API key in the form box_.... Create and rotate keys in the Box dashboard or through the v1 API key endpoints.

Response

Current creation and active-box limits.

​
ok
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
​
standardLimits
object
​
trialLimits
object
​
upgradeEffects
object
​
checkoutRequired
boolean
​
startBlockedReason
string | null
​
contactMessage
string | null
​
activeStates
string[]
​
maxCreationRequestsPerMinute
integer
​
maxCreationRequestsPerDay
integer | null
​
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