The hosting object provides methods to manage the hosting package.
Cancel a hosting package.
Table 2.173. Parameters
Parameter | Description | Type | Required | Default |
---|
hostingId | Hosting package id |
token255
| true | |
No additional return parameters
2.13.2. hosting.controlPanel
Returns the url to the control panel.
Table 2.174. Parameters
Parameter | Description | Type | Required | Default |
---|
id | Hosting package id |
int
| true | |
userAgent | User agent of the client browser |
token0255
| true | |
Table 2.175. Parameters
Parameter | Description | Type | Optional |
---|
url | Url to the hosting control panel |
token255
| |
ip | Ip address of the client |
ip
| |
Order a hosting package.
Table 2.176. Parameters
Parameter | Description | Type | Required | Default |
---|
hostingId | Hosting package id |
token255
| false | |
productId | Hosting package id |
token255
| false | |
testing | Execute command in testing mode |
boolean
| false | false |
No additional return parameters
2.13.4. hosting.getPrices
Get hosting packages prices.
Table 2.177. Parameters
Parameter | Description | Type | Optional |
---|
hosting | | | |
... id | Id of the hosting package |
int
| Yes |
... product | Name of the hosting package product |
int
| Yes |
2.13.5. hosting.issuspended
Check whether a hosting plan is currently suspended
Table 2.178. Parameters
Parameter | Description | Type | Required | Default |
---|
hostingId | ID of the hosting product |
int
| true | |
Table 2.179. Parameters
Parameter | Description | Type | Optional |
---|
isSuspended | Indicates whether the specified hosting plan is currently suspended |
boolean
| |
endDate | Cancellation time of the specified hosting plan |
dateTime
| |
paidUntil | Paid until information for the hosting product |
dateTime
| |
Lists customers hosting packages.
Table 2.180. Parameters
Parameter | Description | Type | Optional |
---|
count | Total number of hosting packages |
int
| |
hosting | | | |
... id | Id of the hosting package |
int
| Yes |
... product | Name of the hosting package product |
int
| Yes |
2.13.7. hosting.reinstate
Reinstate a hosting package.
Table 2.181. Parameters
Parameter | Description | Type | Required | Default |
---|
hostingId | Hosting package id |
token255
| true | |
No additional return parameters
2.13.8. hosting.unsuspend
Unsuspend a suspend hosting product of a customer
Table 2.182. Parameters
Parameter | Description | Type | Required | Default |
---|
hostingId | ID of the hosting product |
int
| true | |
testing | Execute order in testing mode (no order will be submitted) |
boolean
| false | false |
Table 2.183. Parameters
Parameter | Description | Type | Optional |
---|
netPrice | Net price for restoring and extending hosting plan |
float
| |
grossPrice | Gross price for restoring and extending hosting plan |
float
| |
currency | Currency of paid price |
text255
| |
quantity | Quantity |
int
| |
unit | Unit (months or years) |
text255
| |
message | System message |
text255
| |
2.13.9. hosting.updatePeriod
Update the renewal period of a hosting package.
Table 2.184. Parameters
Parameter | Description | Type | Required | Default |
---|
hostingId | ID of the hosting product |
int
| true | |
period | New renewal period |
int
| true | |
No additional return parameters