Get a Subaccount

GET

/v1/subaccounts/:subaccountId

GET

/v1/subaccounts/:subaccountId

curl https://api.bctrl.ai/v1/subaccounts/V1StGXR8_Z5jdHi6B-myT \
     -H "Authorization: Bearer <token>"

{
  "createdAt": "string",
  "defaultSpaceId": "string",
  "id": "V1StGXR8_Z5jdHi6B-myT",
  "limits": {
    "maxActiveRuns": 1,
    "maxSpaces": 1,
    "monthlyCreditLimit": 1.1
  },
  "name": "Production browser",
  "object": "subaccount",
  "status": "active",
  "updatedAt": "string",
  "archivedAt": "string",
  "externalId": "string",
  "metadata": {},
  "usage": {
    "computedAt": "2026-07-26T12:00:00Z",
    "credits": {
      "limit": 1.1,
      "used": 1.1
    },
    "period": {
      "endsAt": "2026-07-26T12:00:00Z",
      "startedAt": "2026-07-26T12:00:00Z"
    },
    "runs": {
      "active": 1,
      "limit": 1
    },
    "spaces": {
      "limit": 1,
      "used": 1
    },
    "subaccountId": "V1StGXR8_Z5jdHi6B-myT"
  }
}

Get one subaccount. Pass include=usage to inline current usage and quota state.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

subaccountIdstringRequired

Query parameters

includelist of enumsOptional

Include optional subaccount expansions. Repeat the query parameter for multiple values.

Allowed values:

Response headers

BCTRL-Request-IdstringOptional

Current request identifier, also echoed in errors.

BCTRL-VersionstringOptional

Negotiated dated API version.

RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

createdAtstring

defaultSpaceIdstringformat: "uuid"

idstring1-64 characters

Opaque identifier for a BCTRL subaccount.

limitsobject

namestring1-200 characters

Customer-facing resource name. 1–200 characters.

object"subaccount"

statusenum

Allowed values:

updatedAtstring

archivedAtstring or nullOptional

externalIdstring or nullOptional

metadataobject or nullOptional

usageobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error