License order in BILLmanager 5

From ISPWiki
Jump to: navigation, search

BILLmanager 4 API is available and you can continue using it. However, we recommend that you upgrade to new API

Order licenses

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

period is a payment period. The same value is used for all types of licenses.

  • period=1 - 1 month
  • period=12 - 1 year
  • period=0 - lifetime

addon_X - the number of nodes (for some types) The autoprolong parameters is used for renewal of licenses. Possible values:

  • autoprolong=1 - auto-renewal for 1 month will be set for a license during the order process
  • autoprolong=12 - auto-renewal for 1 year
  • autoprolong=0 - a license is will be renewed for a lifetime period
  • autoprolong=null - without auto-renewal

pricelist is unique for each license type.

ISPmanager 5 Lite
pricelist=3541
ISPmanager 5 Business
pricelist=4601
Number of nodes:
addon_4602=number
BILLmanager 5 Standard
pricelist=5575
BILLmanager 5 Advanced
pricelist=5577
BILLmanager 5 Corporate
pricelist=5579
IPmanager 5
pricelist=2891
VMmanager KVM
pricelist=3045
Number of nodes:
addon_3049=number
VMmanager Cloud
pricelist=3887
Number of nodes:
addon_3889=number
VMmanager OVZ
pricelist=3651
Number of nodes:
addon_3698=number
DCImanager 5 
pricelist=3934
DCImanager 5 Enterprise
pricelist=3936
DNSmanager 5
pricelist=3136

Disable licenses

https://api.ispsystem.com/manager/billmgr?authinfo=USER:PASSWD&out=xml&func=soft.suspend&elid=license_id

Enable licenses

https://api.ispsystem.com/manager/billmgr?authinfo=USER:PASSWD&out=xml&func=soft.resume&elid=license_id

Change "IP address" or/and "license name":

https://api.ispsystem.com/manager/billmgr?authinfo=USER:PASSWD&out=xml&func=soft.edit&elid=334673&licname=NEWLICNAME&ip=111.222.111.223&sok=ok

Please note:
elid=334673 - license unique identifier. You can find the id by calling a list of licenses (see Example 1)
The licname and ip parameters can be used together or separately, if you want to change only  one parameter

Renew license (e.g. ISPmanager Lite (without support) for 1 month):

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

Check that a license can be ordered on a certain IP address

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

Change activation key

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

Renew Updates package (lifetime licenses)

In order to renew an updates package, execute the API call with the following parameters: func=soft.prolong.update elid=license_id sok=ok

Example: https://api.ispsystem.com/manager/billmgr?authinfo=USER:PASSWD&out=xml&func=soft.prolong.update&sok=ok&elid=license_id

Additional information

  • You can use periods without strict correspondence. For example, your client can order a monthly license that will be ordered as a lifetime license in ISPsystem's billing system. Create the configuration file (a path to the directory with BILLmanager (by default /usr/local/ispmgr)]/etc/cpbillmgr5.conf
  • Then add a new cron job */5 * * * * /usr/local/ispmgr/sbin/cpbillmgr5 checkevent