Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Attributes

FieldTypeDescription
idstringUnique identifier for the account (e.g., "MA_XXXXXX").
api_idstringInternal API reference identifier.
namestringName of the account or company.
emailstringEmail address associated with the account.
phonestringPrimary phone number for the account.
typestringAccount type (e.g., "MASTER", "SUB_ACCOUNT").
auth_idstringAuthentication ID used for API requests.
auth_secretstringSecret key for authentication (only shown in secure contexts).
auth_token_expire_timestringISO 8601 timestamp when the current auth token expires.
descriptionstring | nullOptional description or notes for the account.
companystringFull legal name of the company.
address | city | state | zip_codestringPhysical location details for the account.
countrystring | nullCountry code or name for the account location.
timezonestringLocal timezone of the account (e.g., "America/Los_Angeles").
account_typestringBilling model (e.g., "PREPAID", "POSTPAID").
postpaidbooleanIndicates if the account is on a postpaid billing plan.
auto_rechargebooleanWhether auto-recharge is enabled for prepaid accounts.
enabledbooleanWhether the account is generally enabled for service.
is_activebooleanWhether the account is currently active.
is_verifiedbooleanWhether the account identity has been verified.
is_trial_accountbooleanIndicates if the account is a trial account.
rolestringRole of the user associated with the account (e.g., "ADMIN", "USER").
carrier_typestringType of carrier service (e.g., "VOIP", "PSTN").
customer_typestringType of customer (e.g., "ENTERPRISE", "SMB").
credit_limitstringMaximum credit allowed for postpaid accounts.
cps_limitnumberCurrent calls per second limit for the account.
concurrent_calls_limitnumberCurrent concurrent calls limit for the account.
base_cps_limitnumberBase calls per second limit before any purchased add-ons.
base_concurrent_calls_limitnumberBase concurrent calls limit before any purchased add-ons.
purchased_cpsnumberAdditional CPS purchased by the account.
purchased_concurrent_callsnumberAdditional concurrent calls purchased by the account.
risk_ratingstringRisk assessment rating for the account (e.g., "LOW", "MEDIUM").
risk_statusstringCurrent risk status (e.g., "NORMAL", "FLAGGED").
ip_auth_enabledbooleanWhether IP authentication is enabled for API access.
ip_whitelist_rulesarrayList of IP addresses or CIDR blocks allowed for API access.
allow_aws_ipsbooleanWhether to allow AWS IP ranges for API access.
featuresobjectMap of enabled features like call_queue and transcription_enabled.
limitsobjectIncludes cps_limit, concurrent_calls_limit, and base limits.
pricing_tier_idstringUnique identifier of the pricing tier assigned to this account.
pricing_tierobjectComplete pricing tier object with billing rates and descriptions.
created_atstringISO 8601 timestamp when the account was created.
updated_atstringISO 8601 timestamp when the account was last updated.
last_loginstringISO 8601 timestamp of the most recent login.

​
Example Account Object

{
  "type": "account",
  "id": "500000",
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "name": "John Doe",
  "email": "admin@example.com",
  "phone": "+919876543210",
  "description": "",
  "auth_id": "MA_XXXXXXXX",
  "auth_secret": "<redacted>",
  "auth_token_expire_time": null,
  "country": "IN",
  "timezone": "Asia/Kolkata",
  "city": "Bengaluru",
  "state": "KA",
  "address": "123 Example Street, Bengaluru",
  "zip_code": "560001",
  "company": "Acme Corp",
  "account_type": "standard",
  "postpaid": true,
  "auto_recharge": false,
  "auto_recharge_config": null,
  "enabled": true,
  "carrier_type": null,
  "customer_type": null,
  "credit_limit": 1000,
  "cps_limit": 61,
  "concurrent_calls_limit": 46,
  "base_cps_limit": 41,
  "base_concurrent_calls_limit": 26,
  "purchased_cps": 20,
  "purchased_concurrent_calls": 20,
  "risk_rating": 0,
  "risk_status": null,
  "features": {
    "call_queue": true
  },
  "ip_auth_enabled": false,
  "ip_whitelist_rules": {},
  "allow_aws_ips": false,
  "role": "user",
  "is_active": true,
  "is_verified": false,
  "is_trial_account": false,
  "created_at": "2026-01-19T18:39:14.529435+00:00",
  "updated_at": "2026-05-11T13:31:06.283235+00:00",
  "last_login": "2026-05-11T13:31:06.795577+00:00",
  "pricing_tier_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "pricing_tier": {
    "id": "11223344-5566-7788-99aa-bbccddeeff00",
    "name": "Standard",
    "description": null,
    "currency": "INR",
    "rate_per_minute": 1.2,
    "billing_increment_seconds": 15,
    "minimum_duration_seconds": 15,
    "is_active": true,
    "is_default": false
  }
}
Pricing Tier ObjectEach 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.)