BuycPanel.com Licensing Addon Module v5.3 Prerequisites Before you start you will require: Your BuycPanel.com login email address, (i.e. xxx@xxx.com) Your BuycPanel.com API Key, this is available by logging into your billing.buycpanel.com client account, or by emailing support@buycpanel.com Uploading BuycPanel Module(s) 1. Upload /modules/addons/buycpanel folder and files to your WHMCS directory 2. (Optional) Upload the /modules/servers/buycpanel folder and files to your WHMCS directory and follow the instructions from our provisioning module guide. Activating BuycPanel Addon Module 1. Activate the module in your WHMCS admin panel, (Setup > Addons) 2. Scroll down and enter the following details: a. Email Address Your primary buycpanel.com billing account address b. API Key Your buycpanel.com API key c. Test Mode - When selected no invoices will be raised, and no licenses will be issued d. API Username The module makes use of WHMCS s internal API functions. You must specify an administrative account with API access for the module to work correctly. The module will use admin if none is specified. e. Use Server IP Custom Field The module uses the dedicated IP field to synchronize BuycPanel configurable options products with their parent products within WHMCS. Some clients do not use the dedicated IP field in this way, and so this option allows for the use of a custom field to synchronize license IP addresses instead. You must set a custom field for each product that you assign custom fields to, called Server IP (case sensitive), or this will not function. f. Access Control - You can select which admin role(s) can access the module
Adding Configurable Options The BuycPanel Licensing Module for WHMCS allows you to offer BuycPanel products for purchase to your customers. This is done through the use of configurable options, which allow for our products to be offered as optional addons to your existing products. 2. Click the Generate Configurable Options link in the left sidebar 3. Select the product you want to generate the options for from the select box 4. Choose the licenses you wish to add by checking the boxes 5. Click the Add Configurable Options submit button Optional: If you would like to offer BuycPanel products as full-fledged WHMCS products, please install the optional server provisioning module included in the.zip file! Amend Configurable Options Prices 1. Once you have added Configurable Options you require you must add prices to WHMCS 2. Click (Setup > Configurable Options) 3. You will be presented with a table of Configurable Option Groups, you need to locate the one you need to add pricing to and click the Edit image.
4. You will then see a table with the Configurable Options we added earlier, again click the Edit image next to the license you wish to amend pricing. A popup window will load so make sure any popup blockers you may have installed don t stop this page from loading. 5. Once the page is loaded there are a number of text boxes and select boxes, you must only edit the pricing text boxes, editing anything else on this page may cause the module to malfunction! 6. Once you have finished editing your prices you should click Save Changes then Close Window the window will then close Removing Configurable Options 1. Click (Setup > Configurable Options) 2. You will be presented with a table of Configurable Option Groups, you need to locate the one you want to edit and click the Edit image 3. Do not click the Delete images, simply check the Hidden checkbox for the options you want to remove from the cart, then click Save Changes
Adding New License Manually 2. Click the Add New License button at the top of the page 3. Enter the IP address for which the new license is required, and supply the domain name. 4. Choose the package and submit to order a new license manually. Activating Suspended License You may reactivate suspended licenses through the module from the main Addons > Buycpanel page by using the Activate buttons. 2. The main page will show a list of IP addresses and the package purchased from Buycpanel, as well as the current status of the license and next renewal date. Choose the suspended license that you wish to activate and click on the Unsuspend button. 3. Your licenses can be filtered by status and/or product name by selecting from the Show All Statuses and Show All Products dropdown menus. Your preference will be remembered until you click on the Clear Filter button.
Changing the IP Address of Obtained License The BuycPanel Licensing Module for WHMCS allows you to change your license IP addresses directly from your WHMCS instance. 2. It will show the list of IP addresses and the package purchased from Buycpanel, and the current status of the license along with options. 3. Click the Change button in the options column of any active license. 4. Enter the new IP address and click on Change IP. Paying Invoices (via Credit) for Obtained Licenses The BuycPanel Licensing Module for WHMCS allows for the payment of your BuycPanel licensed products through a convenient interface within your WHMCS instance. The invoices will be paid using credits from your BuycPanel.com account. If sufficient credit is not available you will receive a message stating that more credits are required. 1) Visit (Addons > Buycpanel) 2) Click on View Invoices in the left sidebar 3) Check the boxes for the invoices that you wish to pay with credit 4) Click on Apply Credit to Selected Invoices 5) Click Charge CC if not enough credit to attempt to charge your credit card on file in the case that you have insufficient credit in your account.
Generate WHMCS Products The optional server provisioning module allows for the configuration of BuycPanel licenses as WHMCS products. Any management actions for the product (Create/Terminate/Suspend/Unsuspend) will automatically contact the BuycPanel API and perform the action within your BuycPanel account. If you have enabled this module, you will be able to use the Generate WHMCS Products menu to automatically generate a WHMCS product for any or all of BuycPanel s products. 1. Visit (Addons > Buycpanel) 2. Click on Generate WHMCS Products from the sidebar. 3. Select the WHMCS Product Group that you would like the license(s) to be a member of. 4. Select the BuycPanel products that you wish to create WHMCS products for. 5. After clicking Create Products you will be given a list of products that were created along with links to each individual product s edit page. Please note that you will need to assign prices and any other customizations by editing the product directly. The BuycPanel Licensing Module for WHMCS is property of BuycPanel.com. The module may ONLY be used on WHMCS systems maintained by BuycPanel.com customers. The BuycPanel Licensing Module for WHMCS may not be modified in any form without the express written consent of BuycPanel.com. Custom modifications are available for a fee from BuycPanel.com.