Child pages
  • Example Configurations for HostBill and 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

This page provides a list of example configurations for both Flexiant Cloud Orchestrator and HostBill or WHMCS modules. For details of how to configure your setup for a particular business model, see the sections below. 

Example 1 - Pure Cloud

In this example, we will configure Flexiant Cloud Orchestrator and a HostBill or WHMCS end user module to cater for pure cloud customers. In this business model, customers buy units in advance of their resource usage in a manner similar to a pay as you go mobile phone. In this way, customers only pay for what they use. Normally, there are no fixed monthly fees associated with cloud-style billing, however this can also be accommodated if required.

To configure your setup for a pure cloud business model:

  1. Log in to Flexiant Cloud Orchestrator.

  2. Set up the product offers your customers will use: 
    1. Show the Admin page by clicking the Admin link in the top right hand corner of the screen.
    2. Click on the Platform tab.
    3. On the Product Offers widget, check that you have the product offers you require for cloud-style billing. This will normally consist of multiple unit purchase products, plus product offers for resources for anything you want to charge customers units for using. Typically, these are resources such as servers, networks, disks, image fetches, NICs, and so on. If you do not have a product offer that you require, create a product offer. For information about how to create a product offer, see Creating Product Offers.

      • Ensure that product offers for resources such as servers, disks, networks, and image fetches have an associated unit cost, but that the transaction charge (currency charge) for the unit product offers is always 0.
      • The billing method for your unit product offers should be Arbitrary Unit Billing.
      • No auto top-up product offers are required, as HostBill and WHMCS have native support for automatic rebilling.
    4. Once you have the product offers you require, tag them so that they are not made available to any resource pool or VPS type customers on the platform. For information about how to use tags to manage product offer availability, see Managing Product Offer Availability. An example configuration for tags and product offers is provided on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

  3. Ensure that you have tagged your billing entity appropriately to prevent any resource pool or VPS type product offers in use on the platform from being available to your customers. For an example of how to do this, see the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

  4. Install the end-user (cloud) module for your chosen billing solution. For information about how to do this, see Installing the HostBill modules or Installing the WHMCS modules.

  5. Log in to the admin area of HostBill or WHMCS.
     
  6. Create products for your customers to purchase. These will be representations of the product offers in Flexiant Cloud Orchestrator (step 2 above). As a starting point, products should be configured according to the instructions on the Configuring the HostBill modules or Configuring the WHMCS modules pages, omitting the final step for each module to ensure that the product remains hidden and unavailable to buy until configuration is complete. More specifically, the following detailed configuration is suggested:

    OptionSuggested configuration

    Tags

    None. Tagging is already configured on the product offers in Flexiant Cloud Orchestrator (step 2d above).

    This suggested configuration assumes that you have configured your tags and product offers as detailed on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

    Linked Flexiant Cloud Orchestrator product offersAny unit product offer that you want your cloud customers to be able to buy. The product offers must have been tagged appropriately (step 2d above).
    BillingTo bill the customer once for each unit product offer that they buy, select the Once billing option and enter the currency amount you want to bill the customer in the Price text box. If required, you have the option to charge an initial setup fee, which is added to the value in the Price text box but appears as a separate invoice line on the customer's bill. To do this, enter the required amount in the Setup Fee text box.
    Rebill ThresholdIf required, you can configure a unit purchase to automatically repeat when a customer's unit balance reaches a certain level. To do this, enter the required value in the Rebill Threshold text box.
  7. Once you have configured your product as required, make it available for customers to buy:
    • If you are using the HostBill end user (cloud) module, click on the General tab and click the Show product link. The product is now available for customers to buy.
    • If you are using the WHMCS end user (cloud) module, click on the Details tab and uncheck the Hidden check box. The product is now available for customers to buy.

Example 2 - Post-Purchase Cloud

In this example, we will configure Flexiant Cloud Orchestrator and a HostBill or WHMCS end user module to cater for post-purchase cloud customers. In this business model, customers buy units after they have consumed resources, rather than before they can use the resources as in a pure cloud business model. Normally, there are no fixed monthly fees associated with cloud-style billing, however this can also be accommodated if required.

To configure your setup for a post-purchase cloud business model:

  1. Log in to Flexiant Cloud Orchestrator.
     
  2. Set up the product offers your customers will use: 
    1. Show the Admin page by clicking the Admin link in the top right hand corner of the screen.
    2. Click on the Platform tab.
    3. On the Product Offers widget, check that you have the product offers you require for cloud-style billing. This will normally consist of a unit purchase product with the following settings in the Transaction Amount section: 

      • To be defined: At resource creation.
      • They can choose: From a range.
      • From: leave blank.
      • To: leave blank. 

      You will also need product offers for resources for anything you want to charge customers units for using. Typically, these are resources such as servers, networks, disks, image fetches, NICs, and so on. If you do not have a product offer that you require, create a product offer. For information about how to create a product offer, see Creating Product Offers.

      • Ensure that product offers for resources such as servers, disks, networks, and image fetches have an associated unit cost, but that the transaction charge (currency charge) for the unit product offer is always 0.
      • The billing method for your unit product offer should be Arbitrary Unit Billing.
      • No auto top-up product offers are required, as HostBill and WHMCS have native support for automatic rebilling.
    4. Once you have the product offers you require, tag them so that they are not made available to any resource pool or VPS type customers on the platform. For information about how to use tags to manage product offer availability, see Managing Product Offer Availability. An example configuration for tags and product offers is provided on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

  3. Ensure that you have tagged your billing entity appropriately to prevent any resource pool or VPS type product offers in use on the platform from being available to your customers. For an example of how to do this, see the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.
     
  4. Install the end-user (cloud) module for your chosen billing solution. For information about how to do this, see Installing the HostBill modules or Installing the WHMCS modules.

  5. Log in to the admin area of HostBill or WHMCS.

  6. Create products for your customers to purchase. These will be representations of the product offers in Flexiant Cloud Orchestrator (step 2 above). As a starting point, products should be configured according to the instructions on the Configuring the HostBill modules or Configuring the WHMCS modules pages, omitting the final step for each module to ensure that the product remains hidden and unavailable to buy until configuration is complete. More specifically, the following detailed configuration is suggested:

    OptionSuggested configuration
    Tags

    None. Tagging is already configured on the product offers in Flexiant Cloud Orchestrator (step 2d above).

    This suggested configuration assumes that you have configured your tags and product offers as detailed on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

    Linked Flexiant Cloud Orchestrator product offersAny unit product offer that you want your cloud customers to be able to buy. Additionally, you should create a product in HostBill or WHMCS for the Cloud Post-Purchase product. This product is not linked to a product offer in Flexiant Cloud Orchestrator; it is used to create a customer account in Flexiant Cloud Orchestrator. The product offers must have been tagged appropriately (step 2d above).
    BillingTo bill the customer a currency amount for each unit they spend, select the Metered billing method and enable the Units Pricing billing option. Enter the required currency value in the Unit Price text box.

    If required, you have the option to charge an initial setup fee, which is added to the value in the Unit Price text box but appears as a separate invoice line on the customer's bill. To do this, enter the required amount in the Setup Fee text box. Select the billing period over which the customer is allowed to spend units before they have to pay for their usage. To do this, select the required time period from the Generate Usage Invoices drop down menu. If required, you can charge a fixed recurring fee for the customer to pay each billing period. This allows some degree of revenue forecasting, but is not normally associated with cloud-style billing. To do this, enter the required value in the Fixed Recurring Fee text box.
    Cutoff BalanceThe Cutoff Balance field is used to cut off a customer's account if their unit balance reaches a specified negative level. This is to prevent customers from running up enormous bills, and works similarly to a credit limit on a credit card. Enter the negative unit balance at which to suspend a customer's account, including the negative sign, in the Cutoff Balance field.
  7. Once you have configured your product as required, make it available for customers to buy:
    • If you are using the HostBill end user (cloud) module, click on the General tab and click the Show product link. The product is now available for customers to buy.
    • If you are using the WHMCS end user (cloud) module, click on the Details tab and uncheck the Hidden check box. The product is now available for customers to buy.

Example 3 - Pure resource pool

In this example, we will configure Flexiant Cloud Orchestrator and a HostBill or WHMCS end user module to cater for pure resource pool customers. In this business model, customers are charged a fixed currency amount for a fixed quantity of resources per billing period. This allows easy forecasting of revenue, but at the cost of flexibility for your customers. Normally, there are no unit costs associated with resource pool style billing, however this can also be accommodated if required.

To configure your setup for a pure resource pool business model:

  1. Log in to Flexiant Cloud Orchestrator.
     
  2. Set up the product offers your customers will use: 
    1. Show the Admin page by clicking the Admin link in the top right hand corner of the screen.
    2. Click on the Platform tab.
    3. On the Product Offers widget, check that you have the product offers you require for resource pool style billing. This will normally consist of customer product offers with the appropriate product components, plus product offers for the resources the customer will use. At a minimum you will need product offers for servers, disks, image fetches, and networks. Usually, these product offers are pre-configured with permitted usage values where possible, so that only servers, disks, etc. of a fixed size are available to customers. For a list of the possible components that a customer product offer can contain, see Customer Product ComponentsIf you do not have a product offer that you require, create a product offer. For information about how to create a product offer, see Creating Product Offers.

      If the default customer product offer does not contain the required components, the licensee can create a new customer product with the required components. For information on how to do this, see Creating Products.

    4. The billing method for each required product offer should be set to No charge. This is because the billing for product offers consumed by resource pool customers is handled entirely by HostBill or WHMCS.
    5. Once you have the product offers you require, tag them so that they are not made available to any cloud customers on the platform. For information about how to use tags to manage product offer availability, see Managing Product Offer Availability. An example configuration for tags and product offers is provided on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

  3. Ensure that you have tagged your billing entity appropriately to prevent any cloud type product offers in use on the platform from being available to your customers. For an example of how to do this, see the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.
     
  4. Install the Hostbill end-user (VPS) or WHMCS end user (resource pool) module. For information about how to do this, see Installing the HostBill modules or Installing the WHMCS modules.

  5. Log in to the admin area of HostBill or WHMCS.

  6. Create products for your customers to purchase. These will be representations of the product offers in Flexiant Cloud Orchestrator (step 2 above). As a starting point, products should be configured according to the instructions on the Configuring the HostBill modules or Configuring the WHMCS modules pages, omitting the final step for each module to ensure that the product remains hidden and unavailable to buy until configuration is complete. More specifically, the following detailed configuration is suggested:

    OptionSuggested configuration
    Tags

    Each product created in HostBill or WHMCS should be given the RESPOOL tag. When a customer purchases a tagged product in HostBill or WHMCS, the customer account in Flexiant Cloud Orchestrator is tagged with the same tag. This ensures you do not have to manually tag each new customer account so that it can only see the product offers appropriate to your desired business model.

    This suggested configuration assumes that you have configured your tags and product offers as detailed on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

    Linked Flexiant Cloud Orchestrator product offersAny customer product offers created in step 2 above. The product offers must have been tagged appropriately (step 2e above).
    BillingTo bill the customer a fixed amount for each billing period, select the Regular billing option and enter the required currency amount in the Price text box. If required, you have the option to charge an initial setup fee, which is taken as the customer's first payment before their rate per billing period kicks in. To do this, click the Enable link and enter the required amount in the Setup Fee text box.

    Using the Billing Cycle drop down menu, select the billing period. This determines the interval at which the customer is billed. If required, you can charge a fixed recurring fee for the customer to pay each billing period. To do this, enter the required value in the Fixed Recurring Fee text box.
    Cutoff BalanceAs no units are involved with pure resource pool, the cutoff balance should be left blank to ensure it does not interfere with the operation of the account in Flexiant Cloud Orchestrator.
  7. Once you have configured your product as required, make it available for customers to buy:
    • If you are using the HostBill end user (VPS) module, click on the General tab and click the Show product link. The product is now available for customers to buy.
    • If you are using the WHMCS end user (resource pool) module, click on the Details tab and uncheck the Hidden check box. The product is now available for customers to buy.

Example 4 - Resource pool with bursting

In this example, we will configure Flexiant Cloud Orchestrator and a HostBill or WHMCS end user module to cater for resource pool with bursting customers. In this business model, customers are charged a fixed currency amount for an allowance of resources per billing period, plus a unit amount for each resource they use over their allowance. This allows easy forecasting of revenue and permits some flexibility for your customers. 

To configure your setup for a resource pool with bursting business model:

  1. Log in to Flexiant Cloud Orchestrator.
  2. Set up the product offers your customers will use: 
    1. Show the Admin page by clicking the Admin link in the top right hand corner of the screen.
    2. Click on the Platform tab.
    3. On the Product Offers widget, check that you have the product offers you require for resource pool style billing. This will normally consist of customer product offers with the appropriate product components, plus product offers for the resources the customer will use. At a minimum you will need product offers for servers, disks, image fetches, and networks. Usually, these product offers are pre-configured with permitted usage values where possible, so that only servers, disks, etc. of a fixed size are available to customers. For a list of the possible components that a customer product offer can contain, see Customer Product ComponentsIf you do not have a product offer that you require, create a product offer. For information about how to create a product offer, see Creating Product Offers.

      If the default customer product offer does not contain the required components, the licensee can create a new customer product with the required components. For information on how to do this, see Creating Products.

    4. As the customer will incur a negative unit balance during the billing period if they consume resources beyond their allowance, you also need to create a unit product offer. This is not tied to a HostBill or WHMCS product, but is used by Flexiant Cloud Orchestrator to credit the customer's account with the required number of units at the end of the billing period.The unit product offer should have the following settings: 
      • Transaction Amount section:
        • To be defined: At resource creation.
        • They can choose: From a range.
        • From: leave blank.
        • To: leave blank. 
      • Transaction charge section:
        • To be defined: here.
        • Transaction charge: 0.
      • Billing method: Arbitrary Unit Billing.
    5. The billing method for each required customer product offer should be set to Customer Asset Billing. This allows you to specify a unit cost (specified in the Base unit charge text box) for an allowance of resources (specified in the Asset allowance text box) per billing period, plus a unit cost for each resource created above this allowance (specified in the Units per excess asset text box). When configuring a customer product offer for use with the HostBill or WHMCS modules, the Base unit charge should be set to 0. The Asset allowance and Units per excess asset values can be configured as required.
    6. The billing method for each other product offer used by resource pool customers should be set to No charge. This is because the billing for these product offers is handled entirely by HostBill or WHMCS.
    7. Once you have the product offers you require, tag them so that they are not made available to any cloud customers on the platform. For information about how to use tags to manage product offer availability, see Managing Product Offer Availability. An example configuration for tags and product offers is provided on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

  3. Ensure that you have tagged your billing entity appropriately to prevent any cloud type product offers in use on the platform from being available to your customers. For an example of how to do this, see the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

  4. Install the Hostbill end-user (VPS) or WHMCS end-user (resource pool) module. For information about how to do this, see Installing the HostBill modules or Installing the WHMCS modules.

  5. Log in to the admin area of HostBill or WHMCS.

  6. Create products for your customers to purchase. These will be representations of the product offers in Flexiant Cloud Orchestrator (step 2 above). As a starting point, products should be configured according to the instructions on the Configuring the HostBill modules or Configuring the WHMCS modules pages, omitting the final step for each module to ensure that the product remains hidden and unavailable to buy until configuration is complete. More specifically, the following detailed configuration is suggested:

    OptionSuggested configuration
    Tags

    Each product created in HostBill or WHMCS should be given the RESPOOL tag. When a customer purchases a tagged product in HostBill or WHMCS, the customer account in Flexiant Cloud Orchestrator is tagged with the same tag. This ensures you do not have to manually tag each new customer account so that it can only see the product offers appropriate to your desired business model.

    This suggested configuration assumes that you have configured your tags and product offers as detailed on the Example FCO Configuration for HostBill modules and Example FCO Configuration for WHMCS modules pages.

    Linked Flexiant Cloud Orchestrator product offersAny customer product offers created in step 2 above. The product offers must have been tagged appropriately (step 2g above).
    BillingTo bill the customer a fixed amount for each billing period, select the Regular billing option and enter the required currency amount in the Price text box. If required, you have the option to charge an initial setup fee, which is taken as the customer's first payment before their rate per billing period kicks in. To do this, click the Enable link and enter the required amount in the Setup Fee text box.

    Using the Billing Cycle drop down menu, select the billing period. This determines the interval at which the customer is billed. If required, you can charge a fixed recurring fee for the customer to pay each billing period using the Fixed Recurring Fee text box. As there are units involved in this billing model, you also need to click the Metered link and enable the VPS Bursting Units Price billing option. In the Unit Price text box, enter the required currency amount to charge the customer for each unit spent.
    Cutoff BalanceThe Cutoff Balance field is used to cut off a customer's account if their unit balance reaches a specified negative level. This is to prevent customers from running up enormous bills, and works similarly to a credit limit on a credit card. Enter the negative unit balance at which to suspend a customer's account, including the negative sign, in the Cutoff Balance field.
  7. Once you have configured your product as required, make it available for customers to buy:
    • If you are using the HostBill end user (VPS) module, click on the General tab and click the Show product link. The product is now available for customers to buy.
    • If you are using the WHMCS end user (resource pool) module, click on the Details tab and uncheck the Hidden check box. The product is now available for customers to buy.

Example 5 - Pure VPS

In this business model, customers are charged a fixed currency amount for a server which uses the maximum values for CPU, RAM, and disk space permitted by the customer product offer used for their account. This in effect gives the customer a single server, the parameters of which they can configure at purchase time. There is no provision for logging in to the Flexiant Cloud Orchestrator control panel using this module; end users use only the WHMCS control panel to manage their servers and gain VNC access to them.

To configure your setup for a pure VPS business model:

  1. Log in to Flexiant Cloud Orchestrator.
     
  2. Set up the product offers your customers will use: 
    1. Show the Admin page by clicking the Admin link in the top right hand corner of the screen.
    2. Click on the Platform tab.
    3. On the Product Offers widget, check that you have the product offers you require for VPS style billing. This consists of customer product offers with the appropriate product components, plus product offers for the resources the customer will use. The product offers should be configured as follows: 

      Product offer typeConfiguration
      Server

      Large dynamic range.

      If you need to limit the maximum amount of CPU and RAM for a server that can be provisioned using this product offer, the limit should not be smaller than the Total RAM or Total CPU values on the largest of your customer product offers.

      Disk

      Large dynamic range.

      If you need to limit the maximum size of a disk that can be provisioned using this product offer, the limit should not be smaller than the Total Storage Capacity values on the largest of your customer product offers.

      Customer

      The following customer product components should be configured as required for your service offerings:

      The licensee can create a new customer product with the required components. For information on how to do this, see Creating Products. For information on how to create a product offer that uses the new product, see Creating Product Offers.

      • Total RAM
      • Total CPU
      • Total Storage Capacity
      • Total IPv4 Addresses

        You will need to add a WHMCS product for this customer product offer.

         

      You will also need product offers for image fetches and networks.

    4. The billing method for each required customer product offer should be set to No charge. This is because the billing for these product offers is handled entirely by WHMCS.

    5. The billing method for each other product offer used by VPS customers should be set to No charge. This is because the billing for these product offers is handled entirely by WHMCS.
    6. Once you have the product offers you require, tag them so that they are not made available to any cloud or resource pool customers on the platform. For information about how to use tags to manage product offer availability, see Managing Product Offer Availability. An example configuration for tags and product offers is provided on the Example FCO Configuration for WHMCS modules page.

  3. Ensure that you have tagged your billing entity appropriately to prevent any cloud or resource pool type product offers in use on the platform from being available to your customers. For an example of how to do this, see the Example FCO Configuration for WHMCS modules page.

  4. Install the WHMCS end-user (VPS) module. For information about how to do this, see Installing the WHMCS modules.

  5. Log in to the admin area of WHMCS.
     
  6. If required, define pricing for extra IPv4 addresses.

    This step is not required; IPv4 addresses will be available up to the maximum specified by the Total IPv4 addresses component of the customer product offer, however without performing this step you will not be able to charge for them.

    WHMCS allocates one IPv4 address by default, so the maximum number of extra IPv4 addresses in WHMCS will be one less than the value of the Total IPv4 Addresses customer product component in Flexiant Cloud Orchestrator.


    To define pricing for extra IPv4 addresses: 

    1. From the Setup menu, select Products/Services > Configurable Options.

    2. Click the Edit button for the OneStopShop Configurables group.

    3. Click on Edit button for the Additional IPv4 Addresses option.

    4. Specify the required pricing options for each extra IPv4 address.
    5. Click the Save Changes button. 

  7. If required, define pricing for images.

    This step is not required; images will be available as long as they are owned by the billing entity using the WHMCS end user (VPS) module and shared with Everyone. However without performing this step you will not be able to charge for them.


    To define pricing for images: 

    1. From the Setup menu, select Products/Services > Configurable Options.

    2. Click the Edit button for the OneStopShop Configurables group.

    3. Click on Edit button for the OS Image option.

    4. Specify the required pricing options for each image.
    5. Click the Save Changes button. 
       

  8. Create products for your customers to purchase. These will be representations of the product offers in Flexiant Cloud Orchestrator (step 2 above). As a starting point, products should be configured according to the instructions on the Configuring the WHMCS modules page, omitting the final step for each module to ensure that the product remains hidden and unavailable to buy until configuration is complete. More specifically, the following detailed configuration is suggested:

    OptionSuggested configuration
    Tags

    Each product created in WHMCS should be given the VPS tag. When a customer purchases a tagged product in WHMCS, the customer account in Flexiant Cloud Orchestrator is tagged with the same tag. This ensures you do not have to manually tag each new customer account so that it can only see the product offers appropriate to your desired business model.

    This suggested configuration assumes that you have configured your tags and product offers as detailed on the Example FCO Configuration for WHMCS modules page.

    Linked Flexiant Cloud Orchestrator product offersAny customer product offers created in step 2 above. The product offers must have been tagged appropriately (step 2f above).
    Billing
    1. Click on the Pricing tab. 

    2. From the Payment Type radio buttons, select Recurring

    3. Select the Enable check box in the One Time/Monthly column of the table. 

    4. Fill in the setup fees and prices for One Time/Monthly payment period. 

  9. Once you have configured your product as required, make it available for customers to buy:
    • Click on the Details tab and uncheck the Hidden check box. The product is now available for customers to buy.
  • No labels