The Subaccount Object

The Subaccount object represents an isolated account under your main Vobiz account, with its own authentication credentials, permissions, and rate limiting capabilities.

Attributes

Subaccount Attributes

Parameter	Type	Description
`id`optional	string	Unique identifier for the sub-account (e.g., "SA_67401KW8").
`name`optional	string	Name of the sub-account.
`description`optional	string \| null	Description of the sub-account purpose or usage.
`permissions`optional	object	Permissions object defining what the sub-account can access. Contains boolean fields like "calls" and "cdr".
`rate_limit`optional	integer	API rate limit for this sub-account (requests per time period).
`parent_auth_id`optional	string	ID of the parent main account (e.g., "{Auth_ID}").
`auth_id`optional	string	Authentication ID used for API requests.
`is_active`optional	boolean	Whether the sub-account is currently active and can make API calls.
`created_at`optional	string	ISO 8601 timestamp when the sub-account was created.
`updated_at`optional	string	ISO 8601 timestamp when the sub-account was last updated.
`last_used`optional	string \| null	ISO 8601 timestamp when the sub-account was last used for API calls. Null if never used.

Example Subaccount Object

JSON

{
  "name": "Support Team",
  "description": "Support-facing voice workload",
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "rate_limit": 500,
  "id": "SA_67401KW8",
  "parent_auth_id": "{Auth_ID}",
  "auth_id": "inG9oUky5uFjdUECaQNzeyVYD6ommaJd",
  "is_active": true,
  "created_at": "2025-10-22T03:57:35.997500Z",
  "updated_at": "2025-10-22T03:57:35.997500Z",
  "last_used": null
}

Permissions Object: The permissions object controls what resources the sub-account can access:

calls: Whether the sub-account can make/receive calls
cdr: Whether the sub-account can access Call Detail Records

Rate Limiting: The rate_limit field controls API request throttling for this sub-account. Set this based on expected usage patterns to prevent abuse.

Subaccounts Overview

Create a Subaccount