Function   /domain/book

Function invocation

Function description

Book domain. Domain will be visible on /order/list.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
domain string "" Domain name to register (deprecated, please use 'name' parameter)
name string YES Domain name to register
contactId integer 0 Contact profile id to use for future registration (/contact/list)
contact_id integer 0 Contact profile id to use for future registration (deprecated, please use 'contactId' parameter)
folder_id integer 0 Folder id to use to store registered domain (deprecated and unused)
ips string[] empty array Optional IP Addresses for pointing nameserver (deprecated and unused)
ns string[] empty array Pointing nameservers for example ['', '']
private boolean false Domain WHOIS privacy setting
tags string "" Domain tags, separated by commas
suspended boolean true True to suspend in /order/list.

Return value

Domain book result (structure with the following fields):

Field nameTypeDescription
amount float Domain registration price
currency string Registration price currency
msg string Status message (deprecated)
myAmount float Domain registration price in member account currency
myCurrency string Member's currency
name string Domain name (in Punycode)
nameIDN string Domain name (internationalized)