Loading...

Knowledge Base

Renew Reseller Linux Hosting Orders Using the API

When you want to renew an existing Reseller Linux Hosting order using the API. This article explains renewal parameters, auto-renew settings, invoice options, discount handling, cPanel account block addons, and response details for hosting order renewals.

Renew

Description

Renews an existing Reseller Linux Hosting Order.

Parameters

 

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredThe Order ID which is to be renewed.
monthsIntegerRequiredThe number of months for which the Order is to be renewed.
auto-renewBooleanRequired

Enables / Disables the Auto Renewal setting for the Order.

invoice-optionStringRequiredThis parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
discount-amountFloatOptionalDiscount amount for the order value.
cpanel-blocksIntegerOptional

The addon unit of cPanel accounts. 
If the value of this parameter is 1, 10 cPanel accounts will be added.
(1 cPanel block = 10 cPanel accounts)

Value of this parameter will always be greater than 0

HTTP Method

POST

Example Test URL Request

US Server https://test.httpapi.com/api/resellerhosting/linux/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice&discount-amount=0.00&cpanel-blocks=1 India Server https://test.httpapi.com/api/resellerhosting/linux/in/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice&discount-amount=0.00&cpanel-blocks=1

Response

Returns a map of the execution details of the Renew operation.