The Account Object

The Account object contains all the information about your Vobiz account, including authentication credentials, pricing tier, verification status, and timestamps.

Attributes

Account Attributes

Parameter	Type	Description
`id`optional	string	Unique identifier for the account (e.g., "MA_XXXXXX").
`api_id`optional	string	Internal API reference identifier.
`name`optional	string	Name of the account or company.
`email`optional	string	Email address associated with the account.
`phone`optional	string	Primary phone number for the account.
`type`optional	string	Account type (e.g., "MASTER", "SUB_ACCOUNT").
`auth_id`optional	string	Authentication ID used for API requests.
`auth_secret`optional	string	Secret key for authentication (only shown in secure contexts).
`auth_token_expire_time`optional	string	ISO 8601 timestamp when the current auth token expires.
`description`optional	string \| null	Optional description or notes for the account.
`company`optional	string	Full legal name of the company.
`address \| city \| state \| zip_code`optional	string	Physical location details for the account.
`country`optional	string \| null	Country code or name for the account location.
`timezone`optional	string	Local timezone of the account (e.g., "America/Los_Angeles").
`account_type`optional	string	Billing model (e.g., "PREPAID", "POSTPAID").
`postpaid`optional	boolean	Indicates if the account is on a postpaid billing plan.
`auto_recharge`optional	boolean	Whether auto-recharge is enabled for prepaid accounts.
`enabled`optional	boolean	Whether the account is generally enabled for service.
`is_active`optional	boolean	Whether the account is currently active.
`is_verified`optional	boolean	Whether the account identity has been verified.
`is_trial_account`optional	boolean	Indicates if the account is a trial account.
`role`optional	string	Role of the user associated with the account (e.g., "ADMIN", "USER").
`carrier_type`optional	string	Type of carrier service (e.g., "VOIP", "PSTN").
`customer_type`optional	string	Type of customer (e.g., "ENTERPRISE", "SMB").
`credit_limit`optional	string	Maximum credit allowed for postpaid accounts.
`cps_limit`optional	number	Current calls per second limit for the account.
`concurrent_calls_limit`optional	number	Current concurrent calls limit for the account.
`base_cps_limit`optional	number	Base calls per second limit before any purchased add-ons.
`base_concurrent_calls_limit`optional	number	Base concurrent calls limit before any purchased add-ons.
`purchased_cps`optional	number	Additional CPS purchased by the account.
`purchased_concurrent_calls`optional	number	Additional concurrent calls purchased by the account.
`risk_rating`optional	string	Risk assessment rating for the account (e.g., "LOW", "MEDIUM").
`risk_status`optional	string	Current risk status (e.g., "NORMAL", "FLAGGED").
`ip_auth_enabled`optional	boolean	Whether IP authentication is enabled for API access.
`ip_whitelist_rules`optional	array	List of IP addresses or CIDR blocks allowed for API access.
`allow_aws_ips`optional	boolean	Whether to allow AWS IP ranges for API access.
`features`optional	object	Map of enabled features like call_queue and transcription_enabled.
`limits`optional	object	Includes cps_limit, concurrent_calls_limit, and base limits.
`pricing_tier_id`optional	string	Unique identifier of the pricing tier assigned to this account.
`pricing_tier`optional	object	Complete pricing tier object with billing rates and descriptions.
`created_at`optional	string	ISO 8601 timestamp when the account was created.
`updated_at`optional	string	ISO 8601 timestamp when the account was last updated.
`last_login`optional	string	ISO 8601 timestamp of the most recent login.

Example Account Object

JSON

{
  "id": "MA_XXXXXX",
  "api_id": "api_v1_XXXXXX",
  "name": "Acme Corporation",
  "email": "admin@company.com",
  "phone": "+1234567890",
  "type": "MASTER",
  "auth_id": "YOUR_AUTH_ID",
  "auth_secret": "sk_live_XXXXXXXXXXXXXXXXXXXX",
  "auth_token_expire_time": "2025-11-22T03:16:12Z",
  "description": null,
  "company": "Acme Corp LLC",
  "address": "123 Tech Lane",
  "city": "Innovation City",
  "state": "California",
  "zip_code": "90001",
  "country": "US",
  "timezone": "America/Los_Angeles",
  "account_type": "PREPAID",
  "postpaid": false,
  "auto_recharge": true,
  "enabled": true,
  "is_active": true,
  "is_verified": true,
  "is_trial_account": false,
  "role": "ADMIN",
  "carrier_type": "VOIP",
  "customer_type": "ENTERPRISE",
  "credit_limit": "100.00",
  "cps_limit": 10,
  "concurrent_calls_limit": 50,
  "base_cps_limit": 5,
  "base_concurrent_calls_limit": 25,
  "purchased_cps": 5,
  "purchased_concurrent_calls": 25,
  "risk_rating": "LOW",
  "risk_status": "NORMAL",
  "ip_auth_enabled": false,
  "ip_whitelist_rules": [],
  "allow_aws_ips": true,
  "features": {
    "call_queue": true,
    "transcription_enabled": true
  },
  "pricing_tier_id": "1fa3db95-526a-4b5e-86a6-4bcd62ef31fa",
  "pricing_tier": {
    "id": "1fa3db95-526a-4b5e-86a6-4bcd62ef31fa",
    "name": "baseTier",
    "description": "Standard enterprise pricing plan",
    "currency": "INR",
    "rate_per_minute": "0.4500",
    "billing_increment_seconds": 60,
    "minimum_duration_seconds": 0,
    "is_active": true,
    "is_default": true
  },
  "created_at": "2025-10-17T08:51:00.552579Z",
  "updated_at": "2025-10-22T03:16:11.815251Z",
  "last_login": "2025-10-22T03:16:12.901344Z"
}

Pricing Tier Object

Each account includes a nested pricing_tier object that defines billing rates:

name: Name of the pricing tier (e.g., "baseTier")
description: A brief description of the pricing plan
rate_per_minute: Cost per minute of call time in the specified currency
billing_increment_seconds: Granularity of billing (e.g., 60 = billed by full minutes)
minimum_duration_seconds: Minimum billable duration for calls
currency: Currency code (USD, INR, EUR, etc.)

Account Overview

Retrieve Account Details