Sign in
Box

Get Box limits

Check quota, access readiness, and active-box capacity for the authenticated account.

get/limits

Response

Current creation and active-box limits.

okboolean required
typestring required

Stable success envelope discriminator added by v1.

accessTierstring
blockedReasonstring nullable
upgradeEffectsobject
canStartboolean required

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

checkoutRequiredboolean
startBlockedReasonstring nullable
contactMessagestring nullable
activeBoxesinteger required
activeStatesstring[]
maxActiveBoxesinteger required
maxCreationRequestsPerMinuteinteger
maxCreationRequestsPerDayinteger nullable
hasPaymentHistoryboolean
packageobject
subscriptionQuotaSecondsinteger
subscriptionRemainingSecondsinteger
packBalanceSecondsinteger
creditPurchasedSecondsinteger
creditUsedSecondsinteger
liveUsageSecondsinteger
creditSecondsPerDollarinteger
billingStatusstring required

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

subscriptionStatusstring nullable
subscriptionCancelAtPeriodEndboolean
hasSubscriptionboolean
subscriptionTrialEndsAtstring date-time nullable
subscriptionCurrentPeriodEndstring date-time nullable
creditBalanceSecondsinteger

Example response

{
  "ok": true,
  "accessTier": "trial"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.