ndchost:clientapi:cpanellicensing:order
Table of Contents
Client API order function for the cpanellicensing module
Purpose
The order function allows for adding new licenses under your account.
Parameters
- product (required) - The product name of the product you are ordering, you can get a list of valid products by running the products function
- ip (required) - The IP address to assign to the new license
- billingcycle (required) - Billing cycle to use for this new license, list of valid available billing cycles can be retreived using the products function within the cpanellicensing module
- paymentgateway (optional) - the payment gateway you want to use to pay for this product, you can retrieve a list of valid payment gateways by running the paymentgateways function under the billing module.
Example JSON Response
{
"status": "success",
"message": "Successfully ordered new license on ip 192.168.1.1",
"data": {
"ordernumber": "0000000000",
"invoiceid": "123456",
"orderstatus": "Pending",
"productactivated": "success"
}
}
Note, orderstatus will always be pending on a successful order until manually approved by a staff member. A order status of Review means that a staff member needs to review the order to correct any problems that happened during the order process for example if a product failed to activate.
ndchost/clientapi/cpanellicensing/order.txt · Last modified: by shaun.reitan
