reseller

Description

Adds a user.

Parameters

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/add.json?auth-userid=0&api-key=key&order-id=0&[email protected]&passwd=user-password&[email protected]&first-name=firstname&last-name=lastname&country-code=US&language-code=en


Response

Returns the details of user addition.

These methods allow you to manage email service - email accounts, mailing lists, forwards etc.
These methods can be used for both free as well as paid email (Email Hosting and Enterprise Email).

Description

Gets mock response of the Reseller's Band Pricing. Eventually this response will be a part of this response.

Parameters

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/mock/products/reseller-price.json?auth-userid=0&api-key=key

Response

Returns a map with the prices of Web Services plans.


{"product-key":{"plan-category":{"band-id":{"pricing":{"action":price},"description":{"plan-category-parameter-key":plan-category-parameter-value}}}}


Example:


{"hosting":{"email_plan":{"0":{"pricing":{"renew":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true}},"1":{"description":{"no_of_mail_accounts":1,"default":false}}},"websitebuilder_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"noofpages":50,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":0,"default":false,"bandwidth":0,"noofpages":0,"webspace":0}}},"windows_hosting_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":0,"default":false,"bandwidth":0,"webspace":0}}},"linux_hosting_plan":{"0":{"pricing":{"renew":0.0,"ssl":0.0,"add":0.0},"description":{"no_of_mail_accounts":-1,"default":true,"bandwidth":-1,"webspace":-1}},"1":{"description":{"no_of_mail_accounts":1,"default":false,"bandwidth":1,"webspace":1}}}}}

* -1 denotes Unlimited.

* "pricing" key will come only when pricing is set for that particular band.

* "default":true denotes the default band.

Description

Gets the Customer details for the specified Customer Id.

Parameters

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/customers/details-by-id.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map containing the below details:

• Customer Id (customerid)

• Customer Username (username)

• Reseller Id of the Parent Reseller (resellerid)

• Name (name)

• Company (company)

• Email Address (useremail)

• Telephone Number Country Code (telnocc)

• Telephone Number (telno)

• First line of address of the Customer (address1)

• Second line of address of the Customer (address2)

• Third line of address of the Customer (address3)

• City (city)

• State (state)

• Country Code (country)

• ZIP Code (zip)

• Personal Identification Number (pin)

• Creation Date (creationdt)

• Current Status (customerstatus)

• Sales Contact Id (salescontactid)

• Language Preference for the Control Panel and Emails (langpref)

• Total Receipts (totalreceipts)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Description

Gets a detailed list of the Customer's Archived Transactions, matching the search criteria.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/customer-archived-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1


Response

Returns a hash map of the Customer's Archived Transactions containing the below details:

• Transaction Id (customer_transaction.transid)

• Transaction Date (customer_transaction.transactiondate)

• Order Id associated with the Transaction (customer_transaction.orderid)

• Product Key (customer_transaction.key)

• Transaction Type (customer_transaction.type)

• Transaction Description (customer_transaction.description)

• Whether Transaction is Greedy (greedy)

• Customer Id Associated with the Transaction (customer_transaction.customerid)

• Selling Currency Symbol of the Parent Reseller (customer_transaction.sellingcurrencysymbol)

• Transaction Amount in the Selling Currency (customer_transaction.sellingamount)

• Unutilised Transaction Amount in the Selling Currency (customer_transaction.unutilisedsellingamount)

• Accounting Currency Symbol of the Parent Reseller (customer_transaction.accountingcurrencysymbol)

• Transaction Amount in the Accounting Currency (customer_transaction.accountingamount)

• Unutilised Transaction Amount in the Accounting Currency (customer_transaction.unutilisedaccountingamount)

• Foreign Exchange Difference (forexdiff)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Description

Gets a detailed list of Customer's Transactions, matching the search criteria.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/customer-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1


Response

Returns a hash map of the Customer's Transactions containing the below details:

• Transaction Id (customer_transaction.transid)

• Transaction Date (customer_transaction.transactiondate)

• Order Id associated with the Transaction (customer_transaction.orderid)

• Product Key (customer_transaction.key)

• Transaction Type (customer_transaction.type)

• Transaction Description (customer_transaction.description)

• Whether Transaction is Greedy (greedy)

• Customer Id Associated with the Transaction (customer_transaction.customerid)

• Selling Currency Symbol of the Parent Reseller (customer_transaction.sellingcurrencysymbol)

• Transaction Amount in the Selling Currency (customer_transaction.sellingamount)

• Unutilised Transaction Amount in the Selling Currency (customer_transaction.unutilisedsellingamount)

• Accounting Currency Symbol of the Parent Reseller (customer_transaction.accountingcurrencysymbol)

• Transaction Amount in the Accounting Currency (customer_transaction.accountingamount)

• Unutilised Transaction Amount in the Accounting Currency (customer_transaction.unutilisedaccountingamount)

• Foreign Exchange Difference (forexdiff)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Description

Gets the applicable modify/upgrade price for a particular Web Services Order.

Parameters

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/webservices/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0


Response

Returns the applicable modify/ upgrade price for a particular Web Services Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"modifyCostResult":"upgrade",
"remainingmonths":0,
"currentOrderPrice":0.0
}


where

• currentOrderPrice: The current pricing of the Order for remaining months.

• modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

• upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice