Child pages
  • Configuring the WHMCS modules

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

After installing either of the WHMCS modules, you must configure the module appropriately so that it can be used to sell products. The instructions for this vary depending on the type of module you are installing.

Before configuring the modules, ensure that you have correctly set up your installation of Flexiant Cloud Orchestrator. For instructions on how to do this, see Example FCO Configuration for HostBill modules.

For more information, see the sections below. 

WHMCS reseller module

Once you have installed the WHMCS reseller module, log in to WHMCS and complete the following steps:

  1. Move the cursor over the Setup menu and select Products/Services.
     
  2. Create a new product group by clicking the Create a New Group link and completing the required fields.
     
  3. Create a product: 
    1. Click the Create New Product link.
    2. From the Product Type drop down menu, select Other Product/Service.
    3. From the Product Group drop down menu, select the product group you created in step 2.
    4. Click the Continue button.
    5. On the Details tab, uncheck the Require Domain check box. 
    6. Check the Hidden check box. This is to prevent resellers buying the product before it is fully configured.
    7. On the Module Settings tab, use the Module Name drop down menu to select the required module. For the reseller module, the name of the module is flexiant_reseller.
    8. Select the billing entity to link with the WHMCS product using the Template Resellers drop down menu. 
    9. Select the required billing option(s) using the check boxes. The following billing options are available:
      • Billing on units spent by end users - the reseller is charged the currency amount entered in the Price per Unit Spent text box for each unit spent by the reseller's customers.
      • Billing on units purchased by end users - the reseller is charged the currency amount entered in the Price per Unit Purchased text box for each unit purchased by the reseller's customers.
      • Billing for bandwidth - the reseller is charged the currency amount entered in the Price per MB text box for each MB of data transferred across a network or read from/written to a storage device.
      • Billing per customer product offer - the reseller is charged the value of the WHMCS_MONTHLY_PRICE system key set on each customer product offer purchased by the reseller's customers. This system key is set during configuration of the customer product offer in Flexiant Cloud Orchestrator.
    10. Using the radio buttons at the bottom of the page, select the Automatically setup the product when you manually accept a pending order option. If required, other options for automatic setup can be used, but use of the Do not automatically setup this product option is not recommended.
    11. Click the Save Changes button.
    12. If required, the options on the Pricing tab can be used to configure a once off or regular fixed cost for the product, in addition to the billing option selected on the Module Settings tab. To set up a once off or regular fixed cost for a product:
      1. Click on the Pricing tab and select how to bill the WHMCS product using the Payment Type radio buttons. The following options are available:
        • One Time - bill the product once, with an option to charge an additional setup fee if required.
        • Recurring - bill the product at regular intervals, with an option to charge an initial setup fee if required. 
    13. Click the Save Changes button.
    14. Click on the Details tab and uncheck the Hidden check box. The product is now available for resellers to buy.
    15. Click the Save Changes button.

WHMCS end user module

Once you have installed the WHMCS end user module, log in to WHMCS and complete the following steps:

  1. From the Setup menu, select Products/Services > Products/Services.
     
  2. Create a new product group by clicking the Create a New Group link and completing the required fields. 

    Products are organised on the order form by group, as each group has a separate page, this means products can be split into categories or across several pages for ease of display. The product group is also used to control which order form is used when a customer purchases a product.

      

  3. Create a product: 
    1. Log in to the admin area of WHMCS. 

    2. From the Setup menu, select Products/Services > Products/Services

    3. Click on the Create a New Product link. 

    4. Specify the following: 

      1. Product Type - select the Other Products/Services option from the Product Type drop down. 

      2. Product Group - select the product group you created earlier. 

      3. Product Name - the name to give the product. 

    5. Uncheck the Require Domain check box. 

    6. Click on the Pricing tab. 

    7. Select how to bill the WHMCS product using the Payment Type radio buttons. The following options are available:
      • One Time - bill the product once, with an option to charge an additional setup fee if required.
      • Recurring - bill the product at regular intervals, with an option to charge an initial setup fee if required. 

        Additional billing methods are available on the Module Settings tab if none of the options on the Pricing tab are suitable.

    8. On the Module Settings tab, use the Module Name drop down menu to select the required module. For the end user (cloud), end user (VPS), or end user (resource pool) module, the name of the module is either flexiant_cloud, flexiant_vps, or flexiant_resource_pool.
    9. Do one of the following depending on which module you are configuring:

      ModuleDo this
      flexiant_cloud
      1. Select the product offer to link with the WHMCS product using the Product Offers drop down menu.
      2. Specify any tags to apply to the WHMCS product. Any customer that purchases a tagged WHMCS product has the tag applied to their customer account in Flexiant Cloud Orchestrator. Multiple tags can be entered separated by commas if required.
      3. If required, you can configure the product to automatically rebill using the Rebill Threshold field. When the unit balance of the customer who purchased the product hits this value, they will automatically be billed for the product again and have their Flexiant Cloud Orchestrator customer account credited with the appropriate number of units.
      4. If required, you can configure the customer's account to be suspended once the unit balance specified in the Cutoff field is reached.
      5. Configure the billing for the WHMCS product as required. In addition to whatever fees have been configured on the Pricing tab, it is possible to charge a currency amount for each unit spent. The required currency amount should be entered in the Unit Price text box.
      flexiant_resource_pool
      1. Select the product offer to link with the WHMCS product using the Product Offers drop down menu.
      2. Specify any tags to apply to the WHMCS product. Any customer that purchases a tagged WHMCS product has the tag applied to their customer account in Flexiant Cloud Orchestrator. Multiple tags can be entered separated by commas if required.
      3. Configure the billing for the WHMCS product as required. In addition to whatever fees have been configured on the Pricing tab, it is possible to charge:
        1. A currency amount for each unit charge incurred as a result of using more resource than is accounted for by the associated customer product offer. The currency amount to bill for each unit should be entered in the Unit Price text box.
        2. A currency amount for each MB of data transferred across a network. In a VPS type billing model, this billing method would be used in conjunction with the Regular billing method (configured on the Pricing tab), which you would use to provide a fixed fee per billing period. The currency amount to bill for each unit should be entered in the Unit Price text box.
      flexiant_vps

      Specify the following:

      1. VPS Product Offers - choose the customer product offer to associate with the WHMCS product. 

      2. Default Disk Product Offer - choose the disk product offer to associate with the WHMCS product. When a customer purchases the product, a disk of the maximum size permitted by the customer product offer will be created in their Flexiant Cloud Orchestrator customer account. 

      3. Default Server Product Offer - choose the server product offer to associate with the WHMCS product. When a customer purchases the product, a server with the maximum amount of CPU cores and RAM permitted by the customer product offer will be created in their Flexiant Cloud Orchestrator customer account. 

      4. (Optionally) Bandwidth Price per MB - the customer is billed the currency amount entered in the Unit Price text box for each MB of data transferred across a network.

      5. (Optionally) Cluster - if you intend to limit customers purchasing this product to a particular cluster, enter it here. If no cluster is specified here, the customer can select which cluster to deploy their server in when they purchase the product.

    10. Using the radio buttons at the bottom of the page, select the Automatically setup the product when you manually accept a pending order option. If required, other options for automatic setup can be used, but use of the Do not automatically setup this product option is not recommended.
    11. Click the Save Changes button.
    12. Click on the Details tab and uncheck the Hidden check box. The product is now available for customers to buy.
    13. Click the Save Changes button.
  • No labels