Command reference

Account Commands

View as Markdown

Manage branding, API keys, notification recipients, subaccounts, and usage.

Output formatting flags (--json, --jq, and --template) are documented once in Output Formatting and are omitted from the tables below.

bctrl account get

Get organization settings

$bctrl account get

bctrl account patch

Update organization settings (use —body for branding merge-patch JSON)

$bctrl account patch [flags]
FlagDescription
--dry-runValidate and resolve without persisting

bctrl api-key list

List API keys

$bctrl api-key list [flags]
FlagDescription
--subaccount-id <id>Filter by subaccount id
--type <type>Filter by API key type: organization or subaccount
-L, --limit <number>Maximum number of results to return
--cursor <cursor>Pagination cursor

bctrl api-key create

Create an API key

$bctrl api-key create [flags]
FlagDescription
--name <name>API key name
--subaccount-id <id>Create a key confined to this Subaccount
--expires-at <iso>Expiration timestamp

bctrl api-key delete

Delete an API key

$bctrl api-key delete <keyId> [flags]
FlagDescription
-y, --yesConfirm deletion

bctrl notification-recipient list

List notification recipients

$bctrl notification-recipient list [flags]
FlagDescription
--type <type>Filter by recipient type. Choices: email, sms, whatsapp.
--enabled <enabled>Filter by enabled state. Choices: true, false.
-L, --limit <number>Maximum number of results to return
--cursor <cursor>Pagination cursor

bctrl notification-recipient create

Create a notification recipient

$bctrl notification-recipient create [flags]
FlagDescription
--type <type>Recipient type. Choices: email, sms, whatsapp.
--value <value>Email address, SMS number, or WhatsApp number
--name <name>Display name

bctrl notification-recipient patch

Update a notification recipient

$bctrl notification-recipient patch <recipientId> [flags]
FlagDescription
--value <value>Email address, SMS number, or WhatsApp number
--name <name>Display name
--clear-nameClear the display name
--enabled <enabled>Set enabled state. Choices: true, false.

bctrl notification-recipient delete

Delete a notification recipient

$bctrl notification-recipient delete <recipientId> [flags]
FlagDescription
-y, --yesConfirm deletion

bctrl subaccount list

List subaccounts

$bctrl subaccount list [flags]
FlagDescription
-L, --limit <number>Maximum number of results to return
--cursor <cursor>Pagination cursor
--include-usageInline current usage
--status <status>Filter by status
--external-id <id>Filter by external id
--q <text>Search by id, name, or external id

bctrl subaccount get

Get a subaccount

$bctrl subaccount get <subaccountId> [flags]
FlagDescription
--include <value>Include related data, for example usage

bctrl subaccount create

Create a subaccount

$bctrl subaccount create [flags]
FlagDescription
--name <name>Subaccount name
--external-id <id>External id
--metadata-file <path>Metadata JSON file

bctrl subaccount patch

Update a subaccount

$bctrl subaccount patch <subaccountId> [flags]
FlagDescription
--name <name>Subaccount name
--external-id <id>External id
--metadata-file <path>Metadata JSON file

bctrl subaccount archive

Archive a subaccount

$bctrl subaccount archive <subaccountId> [flags]
FlagDescription
-y, --yesConfirm archive

bctrl subaccount usage

Show subaccount usage

$bctrl subaccount usage [id] [flags]
FlagDescription
-L, --limit <number>Maximum number of usage records to return
--cursor <cursor>Pagination cursor

bctrl usage get

Get organization usage

$bctrl usage get