Function /domain/add/suspended
Function invocation
https://json.aftermarket.pl/domain/add/suspended
Function description
Register domain (operation suspended). The operation will be listed on /order/list and can be activated by /order/resume. If the cost of performing the operation is reduced to 0, the order will not be suspended and will be performed immediately.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| name | string | YES | Domain name to register | |
| contactId | integer | 0 | Contact profile id to use for registration (/contact/list) | |
| ns | string[] | [] | Pointing nameservers for example ['ns1.domain.com', 'ns2.domain.com']) | |
| ips | string[] | [] | Optional IP Addresses for pointing nameserver | |
| private | boolean | false | Domain WHOIS privacy setting | |
| tags | string | "" | Domain tags, separeted by commas | |
| period | integer | 1 | Registration period in years, depends on domain TLD, for most domains allowed values are from 1 to 10, default 1 year. | |
| useCode | boolean | false | Use bonus code |
Return value
Domain registration result (structure with the following fields):
| Field name | Type | Description |
|---|---|---|
| orderId | integer | Order id |
| amount | float | Optional amount |
| currency | string | Currency of optional amount |
| myAmount | float | Amount in member currency of optional amount |
| myCurrency | string | Member's currency |