Skip to main content
POST
/
managed_accounts
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const managedAccount = await client.managedAccounts.create({ business_name: "Larry's Cat Food Inc" });

console.log(managedAccount.data);
{
  "data": {
    "record_type": "managed_account",
    "id": "f65ceda4-6522-4ad6-aede-98de83385123",
    "email": "user@example.com",
    "api_key": "KEY01236170692E74656C6E79782E636F6D_YmlnIGlyb24gaXMgZGVhZA",
    "api_user": "managed_account@example.com",
    "api_token": "x6oexQNHTs-fZ7-QsDMOeg",
    "organization_name": "Example Company LLC",
    "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
    "balance": {
      "record_type": "balance",
      "balance": "300.00",
      "credit_limit": "100.00",
      "available_credit": "400.00",
      "currency": "USD"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "managed_account_allow_custom_pricing": true,
    "rollup_billing": false
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters that define the managed account to be created

​
business_name
string
required

The name of the business for which the new managed account is being created, that will be used as the managed accounts's organization's name.

Example:

"Larry's Cat Food Inc"

​
email
string

The email address for the managed account. If not provided, the email address will be generated based on the email address of the manager account.

Example:

"new_managed_account@customer.org"

​
password
string

Password for the managed account. If a password is not supplied, the account will not be able to be signed into directly. (A password reset may still be performed later to enable sign-in via password.)

Example:

"3jVjLq!tMuWKyWx4NN*CvhnB"

​
managed_account_allow_custom_pricing
boolean

Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed after creation, but there may be time lag between when the value is changed and pricing changes take effect.

Example:

false

​
rollup_billing
boolean

Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.

Example:

false

Response

Successful response with information about a single managed account.

​
data
object