POST
/
v1
/
subaccounts
curl --request POST \
  --url https://api.bland.ai/v1/subaccounts \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "balance": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "login_enabled": true
}'
{
    "status": "success",
    "subaccount_id": "1234567890",
    "subaccount_key": "sub-sk-1234567890"
}

Headers

authorization
string
required

Your API key for authentication.

Body

balance
integer
required

Moves a portion of your API credit balance to the newly created subaccount.

The balance must be a positive integer that is at least 10, and less than your current account balance.

Special per-minute pricing plans carry over automatically to the subaccount, while increased rate limits do not.

Unused credits can be reclaimed later with the subaccount’s balance if needed.

first_name
string
required

The first name of the user who will be using the subaccount.

last_name
string
required

The last name of the user who will be using the subaccount.

login_enabled
boolean
default: "true"

Whether you will be able to log in to the subaccount through the Dev Portal at app.bland.ai.

This enables you to set up credit card information, view and monitor usage, and further manage the subaccount as needed.

The subaccount user will not be able to log into the Dev Portal unless you explicitly enable it by adding them as an Authorized User.

Response

status
string

Whether the subaccount creation succeeded.

subaccount_id
string

The unique identifier for the newly created subaccount.

subaccount_key
integer

The API key that the new subaccount can use to authenticate requests.

This is the only information that the subaccount user will need to start using the API.

Do not use this as an identifier for the subaccount, since it can be rotated.