Create Subaccount | BCTRL Docs

curl -X POST https://api.bctrl.ai/v1/subaccounts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Marketing Team Subaccount"
}'

{
  "createdAt": "2024-04-20T10:15:30Z",
  "defaultSpaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "subacc_987654321",
  "limits": {
    "maxActiveRuns": 50,
    "maxSpaces": 10,
    "monthlyCreditLimit": 5000
  },
  "name": "Marketing Team Subaccount",
  "status": "active",
  "updatedAt": "2024-04-21T08:45:00Z",
  "archivedAt": "null",
  "externalId": "mkt-team-2024",
  "metadata": {},
  "usage": {
    "blockedReasons": [
      "monthlySpendLimit"
    ],
    "computedAt": "2024-04-21T08:00:00Z",
    "credits": {
      "breakdown": {
        "aiCredits": 1200.5,
        "browserCredits": 300,
        "captchaCredits": 150,
        "filesCredits": 450,
        "proxyCredits": 200
      },
      "estimated": 2300.5,
      "limit": 5000,
      "remaining": 2699.5,
      "settled": 2200,
      "used": 2300.5
    },
    "isBlocked": true,
    "period": {
      "endsAt": "2024-04-30T23:59:59Z",
      "startedAt": "2024-04-01T00:00:00Z"
    },
    "runs": {
      "active": 12,
      "blocked": true,
      "limit": 50
    },
    "spaces": {
      "blocked": true,
      "limit": 10,
      "used": 10
    },
    "subaccountId": "subacc_987654321"
  }
}

Create a subaccount for a tenant, customer, environment, or team. Optional limits can be provided inline.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Request

This endpoint expects an object.

namestringRequired1-200 characters

externalIdstringOptional1-200 characters

limitsobjectOptional

metadataobjectOptional

Response

Created

createdAtstring

defaultSpaceIdstringformat: "uuid"

idstring>=1 character

limitsobject

namestring>=1 character

statusenum

updatedAtstring

archivedAtstring or null

externalIdstring or null>=1 character

metadataobject or null

usageobject

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error