idintegerrequired*— Internal identifier of the account. Required — a response with no account id is a broken/drifted payload.
uristring— Canonical URI of the account resource.
bsidstring— Internal identifier of the account in the billing system.
mainNumberstring— Main phone number of the account.
operatorobject— The extension that receives calls/messages addressed to the account operator.
uristring— Link to the operator extension resource.
idinteger— Internal identifier of the operator extension.
extensionNumberstring— Number of the operator extension.
partnerIdstring— Partner-assigned identifier of the operator extension.
partnerIdstring— Additional account identifier assigned by a partner application.
serviceInfoobject— Service information, including brand, sub-brand, service plan, and billing plan.
uristring— Canonical URI of the service info resource.
billingPlanobject— Account billing plan information.
idstring— Internal identifier of the billing plan.
namestring— Billing plan name.
durationUnitstring— Unit the billing plan's duration is measured in.(enum: "Day", "Month", "Year")
durationinteger— Number of duration units.
typestring— Billing plan type.(enum: "Initial", "Regular", "Suspended", "Trial", "TrialNoCC", "Free")
includedPhoneLinesinteger— Included digital lines count.
brandobject— Account brand information.
idstring— Internal identifier of the brand.
namestring— Brand name (e.g. 'RingCentral UK').
homeCountryobject— The brand's home country.
5 fields
idstring— Internal identifier of the country.
uristring— Canonical URI of the country resource.
namestring— The official name of the country.
isoCodestring— ISO 3166-1 alpha-2 country code.
callingCodestring— Country calling code (ITU-T E.123/E.164).
servicePlanobject— Account service plan information.
idstring— Internal identifier of the service plan.
namestring— Name of the service plan.
editionstring— Edition of the service plan.
freemiumProductTypestring— Freemium product type of the service plan, when applicable.(enum: "Freyja", "Phoenix")
targetServicePlanobject— Account target service plan information.
idstring— Internal identifier of the target service plan.
namestring— Name of the target service plan.
editionstring— Edition of the target service plan.
freemiumProductTypestring— Freemium product type of the target service plan, when applicable.(enum: "Freyja", "Phoenix")
contractedCountryobject— Country the account is contracted in.
idstring— Internal identifier of the country.
uristring— Canonical URI of the country resource.
namestring— The official name of the country.
isoCodestring— ISO 3166-1 alpha-2 country code.
callingCodestring— Country calling code (ITU-T E.123/E.164).
uBrandobject— Account sub-brand information.
idstring— Sub-brand unique ID.
namestring— Sub-brand name.
setupWizardStatestring— State of the account's initial configuration wizard.(enum: "NotStarted", "Incomplete", "Completed", "Unknown")
signupInfoobject— Account sign-up data.
tosAcceptedboolean— Whether the account holder accepted the terms of service.
signupStatearray— Ordered set of signup milestones the account has completed.
[]string(enum: "AccountCreated", "BillingEntered", "CreditCardApproved", "AccountConfirmed", "PhoneVerificationRequired", "PhoneVerificationPassed")
verificationReasonstring— Why the account required additional signup verification, when applicable.(enum: "CC_Failed", "Phone_Suspicious", "CC_Phone_Not_Match", "AVS_Not_Available", "MaxMind", "CC_Blacklisted", "Email_Blacklisted", "Phone_Blacklisted", "Cookie_Blacklisted", "Device_Blacklisted", "IP_Blacklisted", "Agent_Instance_Blacklisted", "Charge_Limit", "Other_Country", "Unknown")
marketingAcceptedboolean— Whether the account holder opted in to marketing communications.
creationTimestring— Timestamp the account was created, ISO 8601.
statusstring— Status of the account.(enum: "Initial", "Confirmed", "Unconfirmed", "Disabled")
statusInfoobject— Additional information present when the account is in 'Disabled' status.
reasonstring— Type of suspension/cancellation, voluntary or not.(enum: "SuspendedVoluntarily", "SuspendedInvoluntarily", "CancelledVoluntarily", "CancelledInvoluntarily")
commentstring— A meaningful description of the status change reason.
tillstring— Date after which the account will be deleted, ISO 8601 date-time.
regionalSettingsobject— Account-level regional settings (home country, timezone, language, currency, etc).
homeCountryobject— The account's home country.
idstring— Internal identifier of the country.
uristring— Canonical URI of the country resource.
namestring— The official name of the country.
isoCodestring— ISO 3166-1 alpha-2 country code.
callingCodestring— Country calling code (ITU-T E.123/E.164).
timezoneobject— The account's default timezone.
idstring— Internal identifier of the timezone.
uristring— Canonical URI of the timezone resource.
namestring— Short name of the timezone.
descriptionstring— Meaningful description of the timezone.
biasstring— Timezone UTC offset bias.
languageobject— The account's regional language.
idstring— Internal identifier of the language/locale.
localeCodestring— Localization code (e.g. en-US).
namestring— Official name of the language/locale.
greetingLanguageobject— Language used for telephony greetings.
idstring— Internal identifier of the language/locale.
localeCodestring— Localization code (e.g. en-US).
namestring— Official name of the language/locale.
formattingLocaleobject— Locale used to format numbers, dates, and currencies.
idstring— Internal identifier of the language/locale.
localeCodestring— Localization code (e.g. en-US).
namestring— Official name of the language/locale.
timeFormatstring— Time format setting; defaults to '12h' when unset.(enum: "12h", "24h")
currencyobject— The account's billing currency.
idinteger— Internal identifier of the currency.
codestring— Official code of the currency (e.g. USD).
namestring— Official name of the currency.
symbolstring— Graphic symbol of the currency (e.g. $).
minorSymbolstring— Minor graphic symbol of the currency (e.g. ¢).
federatedboolean— Whether the account is included in any federation of accounts.
outboundCallPrefixinteger— Outbound call prefix digit (2-9), when configured.
cfidstring— Customer-facing identifier; the main company number in E.164 format without '+'.
limitsobject— Limits effective for the account.
freeSoftPhoneLinesPerExtensioninteger— Max number of free softphone lines per user extension.
meetingSizeinteger— Max number of participants in a RingCentral meeting hosted by this account's users.
cloudRecordingStorageinteger— Meetings recording cloud storage limit, in GB.
maxMonitoredExtensionsPerUserinteger— Max number of extensions a single user can monitor for Presence.
maxExtensionNumberLengthinteger— Max length of the account's extension numbers.
siteCodeLengthinteger— Length of a site code.
shortExtensionNumberLengthinteger— Length of a short extension number.