Reselling of ISPmanager 5 licenses via API

This is the documentation for the deprecated product BILLmanager 5. It is no longer updated and may be irrelevant. Documentation for the current version of BILLmanager can be found in the BILLmanager 6 section.

This article describes how to use API for reselling ISPmanager 5 licenses.

The API address of the ISPsystem billing system: https://api.ispmanager.com.

Authentification is performed with the authinfo parameter which value is authinfo=user:passwd, where user is a username in the billing system https://eu.ispmanager.com; passwd is his password.

Note:

On January 1, 2022, the support and release of updates for ISPmanager 5 (Lite, Business) will be discontinued. Read more in Support stages. Meanwhile:

licenses purchased before April 8, 2021 will be supported until their expiration date in LTS mode;

from April 8 to June 15, 2021, licenses can be renewed and purchased until December 31, 2021. Starting June 15, 2021, the sale and renewal of licenses will be discontinued.

Order license

To order a license, use the soft.order.param function with the following parameters:

skipbasket — do not add services to the cart and charge the client immediately. Possible values:
- on — activate a service without putting it into the cart;
- off — activate the service from the cart. This is the default value that you may not specify in the request;
ip — license IP-address.
licname — license name.
period — licensing period. Possible values:
- period=1 — 1 month
- period=12 — 1 year
autoprolong — license renewal parameter. Possible values:
- autoprolong=1 — when a client orders a service, auto-renewal for 1 month will be set
- autoprolong=12 - auto-renewal for 1 year
- autoprolong=null — without auto-renewal
pricelist — tariff code. Possible values:
- ISPmanager Lite: pricelist=3541
- ISPmanager Business: pricelist=4601; addon_4602=<amount>
addon_X — number of nodes for some types of licenses.

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.order.param&clicked_button=finish&ip=82.156.37.16&licname=name&period=1&pricelist=4601&addon_4602=1&autoprolong=1&sok=ok&skipbasket=on

Renew license

To renew a license use the service.prolong function which has the following parameters:

elid — license id.
period — renewal period. Possible values:
- period=1 — 1 month
- period=12 — 1 year

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=service.prolong&elid=334673&period=1&sok=ok

Change license parameters

The soft.edit function allows changing the IP-address and name of the license. The new license name is passed with the licname parameter, and the new IP-address is passed with the ip parameter.

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.edit&elid=334673&licname=<new license name>&ip=<new IP-address>&sok=ok

Suspend license

Call the soft.suspend function to suspend a license:

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.suspend&elid=<license id>

Activate license

Call the soft.resume function to activate a license:

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=&out=xml&func=soft.resume&elid=<license id>

Check license order

Call the soft.checkip function to check if it is possible to order a license on a specific IP address.

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&func=soft.checkip&pricelist=7&period=1&ip=82.145.17.16

Re-generate license key

To change the license key, call the soft.edit function. The clicked_button=newkey parameters define if the system should re-generate a new key.

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=user:passwd&out=xml&clicked_button=newkey&elid=2512171&func=soft.edit&sok=ok

Delete license

Call the soft.delete function to delete a license:

Example of function call

https://api.ispsystem.com/manager/billmgr?authinfo=&out=xml&func=soft.delete&elid=<license code>