Get Subaccount

GET

/v1/subaccounts/:subaccountId

GET

/v1/subaccounts/:subaccountId

$ curl https://api.bctrl.ai/v1/subaccounts/subaccountId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "createdAt": "2024-04-01T12:00:00Z",
3   "defaultSpaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "id": "subacct-98765",
5   "limits": {
6     "maxActiveRuns": 10,
7     "maxSpaces": 5,
8     "monthlyCreditLimit": 500
9   },
10   "name": "Marketing Team Subaccount",
11   "status": "active",
12   "updatedAt": "2024-04-20T08:30:00Z",
13   "archivedAt": null,
14   "externalId": "ext-12345",
15   "metadata": {},
16   "usage": {
17     "blockedReasons": [
18       "monthlySpendLimit"
19     ],
20     "computedAt": "2024-04-20T08:30:00Z",
21     "credits": {
22       "breakdown": {
23         "aiCredits": 120.5,
24         "browserCredits": 30,
25         "captchaCredits": 15,
26         "filesCredits": 10,
27         "proxyCredits": 25.5
28       },
29       "estimated": 200,
30       "limit": 500,
31       "remaining": 300,
32       "settled": 150,
33       "used": 200
34     },
35     "isBlocked": true,
36     "period": {
37       "endsAt": "2024-04-30T23:59:59Z",
38       "startedAt": "2024-04-01T00:00:00Z"
39     },
40     "runs": {
41       "active": 3,
42       "blocked": true,
43       "limit": 10
44     },
45     "spaces": {
46       "blocked": true,
47       "limit": 5,
48       "used": 5
49     },
50     "subaccountId": "subacct-98765"
51   }
52 }

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

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

subaccountIdstringRequired

Query parameters

include"usage" or list of "usage"Optional

Response

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

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error