Difference between revisions of "Product Addons"

From WHMCS Documentation

m
m (How addons are displayed)
 
(5 intermediate revisions by the same user not shown)
Line 20: Line 20:
 
#Enter a '''Name''' and '''Description''', then click ''Save Changes''. The other options on this page are optional and can be changed later:
 
#Enter a '''Name''' and '''Description''', then click ''Save Changes''. The other options on this page are optional and can be changed later:
 
##Tick the '''Tax Addon''' box if tax rules should be applied to this addon
 
##Tick the '''Tax Addon''' box if tax rules should be applied to this addon
##Tick '''Show on Order''' if you want the addon to be displayed during the initial order process. Leaving it unchecked means clients can choose to order it later from the client area only.
+
##Tick '''Show on Order''' if you want the addon to be displayed during the initial order process. When disabled, the addon can only be ordered from an existing service. This can be useful for addons that you may not wish to offer right away on new signups. As such, unlike the Hidden or Retired options, this doesn't hide the addon from the client area and order form, nor completely prevent it from being ordered.
 
##Ticking '''Suspend Parent Product''' will cause the parent product to which the addon belongs to be suspended should it become overdue on payment per your automation settings.
 
##Ticking '''Suspend Parent Product''' will cause the parent product to which the addon belongs to be suspended should it become overdue on payment per your automation settings.
 
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon when activated
 
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon when activated
 
##'''Addon Weighting''' – By default addons are listed on the order form alphabetically (set addon weighting value to 0), this display order can be customised by entering a weighting for each addon. A value of 1 would mean the addon was displayed at the top of the list, an addon with a weighting of 2 displayed beneath it and so on...
 
##'''Addon Weighting''' – By default addons are listed on the order form alphabetically (set addon weighting value to 0), this display order can be customised by entering a weighting for each addon. A value of 1 would mean the addon was displayed at the top of the list, an addon with a weighting of 2 displayed beneath it and so on...
 
##'''Hidden''' - Tick to not show the addon on the order form - can still be ordered using the direct order links and added as an Admin
 
##'''Hidden''' - Tick to not show the addon on the order form - can still be ordered using the direct order links and added as an Admin
##'''Retire''' - When ticked the addon is hidden from both admin and client. The addon will not appear on the orderform or appear selectable in admin management. This will not change existing purchased addons.
+
##'''Retired''' - When ticked the addon is hidden from both admin and client. The addon will not appear on the orderform or appear selectable in admin management. This will not change existing purchased addons.
 
#Under the '''Pricing''' tab, enter the prices for each of your activated currencies - setup fees to be charged at the initial time of order only and recurring amounts to be charged every cycle
 
#Under the '''Pricing''' tab, enter the prices for each of your activated currencies - setup fees to be charged at the initial time of order only and recurring amounts to be charged every cycle
 
#Under the '''Module Settings''' tab, if you'd like the addon to trigger provisioning, select a [[Server_Modules|Module Name]] which should be triggered when the addon is ordered.
 
#Under the '''Module Settings''' tab, if you'd like the addon to trigger provisioning, select a [[Server_Modules|Module Name]] which should be triggered when the addon is ordered.
Line 33: Line 33:
 
#If an '''Associated Download''' is selected, once the addon's status is Active, the chosen file(s) will become available for the client to download under the parent product's Downloads tab in the client area (Services > My Services > View Details > Downloads tab). For more information refer to [[Product Download Distribution]].
 
#If an '''Associated Download''' is selected, once the addon's status is Active, the chosen file(s) will become available for the client to download under the parent product's Downloads tab in the client area (Services > My Services > View Details > Downloads tab). For more information refer to [[Product Download Distribution]].
 
Finally, click Save Changes
 
Finally, click Save Changes
 +
 +
===How Addons are Displayed===
 +
Below is a table showing how the Show On Order, Hidden and Retired options affect addon display when enabled.
 +
 +
<table class="table table-bordered">
 +
<tr><th></th><th class="text-center">Show on Order</th><th class="text-center">Hidden</th><th class="text-center">Retired</th></tr>
 +
<tr><td>Order Form</td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
 +
<tr><td>Client Area Order Addons</td><td class="text-center"></td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
 +
<tr><td>Admin Area Search Filters</td><td></td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
 +
<tr><td>Admin Area Order Form</td><td></td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
 +
</table>
  
 
===Managing Addons===
 
===Managing Addons===

Latest revision as of 14:05, 5 November 2019

Product Addons let you offer additional items which the client has a yes/no choice over and are billed seperately from the product. Configurable Options on products allow you to give your clients variables which alter the price of that product. In this article, we will look at when you would use them and how.

When should I use configurable options instead of addons?

  • If you want to offer a choice of options for a single thing - for example Disk Space, Operating System, Locations, etc...
  • If you want the total amount to be billed as a single item and not seperately
  • When you want the billing cycle of the addon to match the billing cycle of the product

When should I use addons instead of configurable options?

  • If the item is a one off service
  • If it can be selected independently of other items
  • If it should be billed on it's own cycle - eg. a dedicated IP might be billed annually regardless of the package cycle
  • Not subject to prorata at a product level or client-wide signup anniversary prorata.

Product Addons

Creating a New Addon

  1. Begin by going to Setup > Products/Services > Product Addons > Add New
  2. Enter a Name and Description, then click Save Changes. The other options on this page are optional and can be changed later:
    1. Tick the Tax Addon box if tax rules should be applied to this addon
    2. Tick Show on Order if you want the addon to be displayed during the initial order process. When disabled, the addon can only be ordered from an existing service. This can be useful for addons that you may not wish to offer right away on new signups. As such, unlike the Hidden or Retired options, this doesn't hide the addon from the client area and order form, nor completely prevent it from being ordered.
    3. Ticking Suspend Parent Product will cause the parent product to which the addon belongs to be suspended should it become overdue on payment per your automation settings.
    4. Choose a Welcome Email if you want to send an email notification relating to the new addon when activated
    5. Addon Weighting – By default addons are listed on the order form alphabetically (set addon weighting value to 0), this display order can be customised by entering a weighting for each addon. A value of 1 would mean the addon was displayed at the top of the list, an addon with a weighting of 2 displayed beneath it and so on...
    6. Hidden - Tick to not show the addon on the order form - can still be ordered using the direct order links and added as an Admin
    7. Retired - When ticked the addon is hidden from both admin and client. The addon will not appear on the orderform or appear selectable in admin management. This will not change existing purchased addons.
  3. Under the Pricing tab, enter the prices for each of your activated currencies - setup fees to be charged at the initial time of order only and recurring amounts to be charged every cycle
  4. Under the Module Settings tab, if you'd like the addon to trigger provisioning, select a Module Name which should be triggered when the addon is ordered.
  5. Select the provisioning option which controls when you'd like this addon to be activated; as soon as the order is placed, when the first payment is received, when you manually accept a pending order or never.
    Note
    In version 7.1 and earlier a single Autoactivate on Payment option was available. In version 7.2 and above this is replaced with four provisioning options.
  6. When used with addons, Custom Fields are for internal use only and are typically auto-populated by modules.
  7. Under the Applicable Products tab, click the products to which the addon applies in the Available Products column they will move to the Selected Products column and therefore appear during the ordering process for the selected products. To de-select a product click; it's name in the Selected Products column.
  8. If an Associated Download is selected, once the addon's status is Active, the chosen file(s) will become available for the client to download under the parent product's Downloads tab in the client area (Services > My Services > View Details > Downloads tab). For more information refer to Product Download Distribution.

Finally, click Save Changes

How Addons are Displayed

Below is a table showing how the Show On Order, Hidden and Retired options affect addon display when enabled.

Show on OrderHiddenRetired
Order Form
Client Area Order Addons
Admin Area Search Filters
Admin Area Order Form

Managing Addons

  • To manage existing addons, go to Setup > Products/Services > Product Addons
  • From here you can view, edit and delete existing addons
  • You will not be able to delete an addon if it is in use by customers
  • Modifying addons gives you exactly the same layout and options as adding a new one

Assigning Addons to Customers

  • In addition to clients being able to order addons from the client area, admins can issue addons to customers
  • Refer to Products Management#Addons for details

Configurable Options

Information on Configurable Options can be found on their own page.