Account & Org

Issue API keys, isolate customers into subaccounts, and meter usage per subaccount from a single organization.

The apiKeys, subaccounts, and usage clients are reachable two ways: directly on the client (bctrl.apiKeys) or grouped under bctrl.account.apiKeys. Both point at the same client.

Who am I

Check the actor behind the current API key:

1
const me = await bctrl.auth.whoami();

API keys

1
const created = await bctrl.apiKeys.create({ name: "ci-key" });
2
console.log(created.secret);   // shown once - store it now
3
console.log(created.data.id);
4
5
const { data } = await bctrl.apiKeys.list();
6
await bctrl.apiKeys.delete(created.data.id);

The secret is returned only at creation time. Issue a key scoped to a subaccount with subaccountId.

Subaccounts

Each subaccount is an isolated, separately-billed environment for one of your customers, under your organization.

1
const sub = await bctrl.subaccounts.create({
2
  name: "Acme Corp",
3
  externalId: "acme",
4
});
5
6
const { data } = await bctrl.subaccounts.list();
7
const one = await bctrl.subaccounts.get(sub.id);
8
9
await bctrl.subaccounts.update(sub.id, { name: "Acme Inc" });
10
await bctrl.subaccounts.archive(sub.id);

A parent-org key can act on any subaccount with ?subaccountId=; a subaccount-scoped key is automatically confined to its own subaccount.

Usage

Read organization usage, or per-subaccount usage:

1
const org = await bctrl.usage.get();
2
const perSub = await bctrl.subaccounts.usage.list();

Next

• Spaces - scope work within a subaccount
• SDK Essentials - pagination, errors, idempotency
• API Reference - every account endpoint