Get Specific Domain With Billing Summary

get https://{server}/ns-api/v2/domains/{domain}/billing

Responses

Response body

object

domain

string

required

length ≤ 64

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

reseller

string

required

This is the reseller that owns this domain. Must be a valid resller name on creation. If Reseller level scope you can use "~" to set your own reseller on create, Super User's will need to set this to a valid Reseller.

description

string

required

This is a description of the domain. This will be shown in many places to help show a more user friendly version of the domain to help identify it.

music-on-hold-enabled

string

yes no

music-on-ring-enabled

string

yes no

music-on-hold-randomized-enabled

string

yes no

domain-type

string

Allows a special domain type to be set for specific use cases. Currently Residenital and Hospitality are options which will limit and effect the users expierence.

Standard Residential Hospitality

dial-plan

string

This is the default dial plan that will be used for new users created in the domain. A dial plan is created by default on new domain creation with a name matching the domain.

dial-policy

string

This is the default dial policy (permission) that will be used for new users added ot the domain. Generally these are system wide policies and will not need to create one per domain.

email-send-from-address

string

This is the email source that will be used when sending out emails for this domain. This address should be configured properly through the email server so that emails are not blocked. In most cases this is recommended to be an address on the service providers or resellers hostname so DNS SPF records can be added on the hostname to prevent spam issues. More info on SPF records available via https://www.cloudflare.com/learning/dns/dns-records/dns-spf-record/

single-sign-on-enabled

string

yes no

area-code

number

100 to 999

The default area code for the domain. This is used by default on 7 digit dials to extent the number to a valid 10 digit number.

caller-id-name

string

This is the main caller id name for the user to be used for outbound calls outside of the domain.

caller-id-number

number

This is the main caller id number for the user to be used for outbound calls outside of the domain.

caller-id-number-emergency

number

This is the main caller id that will be used for emergency calls when placed by the user.

limits-max-subcriber-resources-total

integer

This is the maximum number of subscribers allowed for domain including the subscribers that would be created as part of resources like call queues and auto attendants. If looking to limit nornal users it would be better to use limits-max-users

limits-max-active-calls-total

integer

This is the limit for the number of active calls allowed in the domain simultaniously. Note: this will count and limit intra domain calls.

limits-max-active-calls-offnet

integer

This is the limit for the number of active calls allowed in the domain simultaniously that are connected to offnet or external numbers.

limits-max-call-queues

integer

This is the maximum number of call queues that would be allowed to be created in this domain.

limits-max-auto-attendants

integer

This is the maximum number of auto attendants that would be allowed to be created in this domain.

limits-max-conferences

integer

This is the maximum number of conference bridges that would be allowed to be created in this domain.

limits-max-departments

integer

This is the maximum number of departments that would be allowed to be created in this domain.

limits-max-users

integer

This is the maximum number of regular users that would be allowed to be created in this domain.

limits-max-sites

integer

This is the maximum number of sites that would be allowed to be created in this domain.

limits-max-fax-accounts

integer

This is the maximum number of fax accounts that would be allowed to be created in this domain.

time-zone

string

The timezone which the meeting was created with

US/Alaska US/Central US/Eastern US/Hawaii US/Mountain US/Pacific Africa/Addis_Ababa Africa/Algiers Africa/Brazzaville Africa/Cairo Africa/Casablanca Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Johannesburg Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Nairobi Africa/Timbuktu Africa/Tripoli Africa/Tunis America/Antigua America/Aruba America/Belize America/Bogota America/Buenos_Aires America/Cancun America/Caracas America/Cayman America/Chihuahua America/Costa_Rica America/Denver America/Detroit America/Edmonton America/El_Salvador America/Ensenada America/Grenada America/Guadeloupe America/Guatemala America/Havana America/Indianapolis America/Jamaica America/Juneau America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Martinique America/Mazatlan America/Mendoza America/Menominee America/Merida America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Panama America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Regina America/Santiago America/Santo_Domingo America/Sao_Paulo America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Vancouver America/Winnipeg America/Yellowknife Antarctica/South_Pole Arctic/Longyearbyen Asia/Amman Asia/Baghdad Asia/Bahrain Asia/Bangkok Asia/Beirut Asia/Brunei Asia/Calcutta Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dubai Asia/Gaza Asia/Hong_Kong Asia/Istanbul Asia/Jakarta Asia/Jerusalem Asia/Kabul Asia/Katmandu Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Manila Asia/Muscat Asia/Phnom_Penh Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Taipei Asia/Tehran Asia/Tel_Aviv Asia/Thimphu Asia/Tokyo Asia/Ulan_Bator Asia/Vientiane Asia/Vladivostok Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Reykjavik Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Canberra Australia/Darwin Australia/LHI Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Cuba Etc/GMT Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/Greenwich Europe/Amsterdam Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Copenhagen Europe/Dublin Europe/Helsinki Europe/Istanbul Europe/Kiev Europe/Lisbon Europe/Ljubljana Europe/London Europe/Madrid Europe/Malta Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Prague Europe/Rome Europe/Sofia Europe/Stockholm Europe/Vienna Europe/Warsaw Europe/Zurich Greenwich Pacific/Auckland Pacific/Easter Pacific/Fiji Pacific/Galapagos Pacific/Gambier Pacific/Guam Pacific/Honolulu Pacific/Marquesas Pacific/Midway Pacific/Palau Pacific/Rarotonga Pacific/Tahiti

email-send-smtp-hostname

string | null

This is the SMTP server hostname. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

email-send-smtp-port

string | null

This is the SMTP port for sending emails. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

email-send-smtp-username

string | null

This is the username used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

email-send-smtp-password

string | null

This is the password used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

active-calls-total-current

integer

This is the total active calls for the domain including on-net (intra domain) calls and calls across geo servers and calls linked to "guest" video sessions

active-calls-against-license-count

integer

This is the total active calls for the domain including on-net (intra domain) calls but counted as the license would be enforced inlcuding ignoring geo call legs and guest video sessions.

active-calls-offnet-current

integer

This is the total active calls for the domain only including calls that are connected to a remote (non intra domain) caller/calling party.

count-subcriber-resources-total

integer

This is the total number of users plus all the system users as well for the entire domain.

emergency-address-id

string | null

Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling

voicemail-enabled

string

yes no

recording-configuration

string

Defaults to no

Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"

yes yes-with-transcription yes-with-transcription-and-sentiment no

voicemail-transcription-enabled

string

Defaults to no

Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded.

no Deepgram Google Mutare Voicebase

language-token

string

Defaults to en_US

This is the language that is set for the user to be used for portal viewing.

is-domain-locked

string

yes no

is-stir-enabled

string

yes no

is-ivr-forward-change-blocked

string

yes no

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://ns-api.com/ns-api/v2/domains/~/billing' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Authentication Required

404Record Not Found

x-404:Record not foundRecord not found