Difference between revisions of "Product Addons"

From WHMCS Documentation

m (→‎How addons are displayed)
Line 1: Line 1:
−
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.
+
Product Addons let you offer additional items which the client can enable or disable. The system will bill them seperately from the product. [[Configurable Options]] on products allow you to give your clients variables that alter the price of that product.
  
 
===When should I use configurable options instead of addons?===
 
===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 to offer a choice of options for a single item (for example, Disk Space, Operating Systems, or Locations).
−
*If you want the total amount to be billed as a single item and not seperately
+
*If you want to bill the total amount as a single item and not seperately.
−
*When you want the billing cycle of the addon to match the billing cycle of the product  
+
*If 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?===
 
===When should I use addons instead of configurable options?===
  
−
*If the item is a one off service
+
*If the item is a one-time service.
−
*If it can be selected independently of other items
+
*If clients can select the item independantly 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
+
*If you want to bill it on its own cycle (for example, you could bill a dedicated IP address annually regardless of the package cycle).
−
*Not subject to prorata at a product level or client-wide signup anniversary prorata.
 
  
 
==Product Addons==
 
==Product Addons==
 
===Creating a New Addon===
 
===Creating a New Addon===
  
−
#Begin by going to '''Setup > Products/Services > Product Addons > Add New'''
+
To create a new addon:
−
#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
+
#Go to '''Setup > Products/Services > Product Addons > Add New'''
−
##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.
+
#Enter a '''Name''' and '''Description'''
−
##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.
+
# Click ''Save Changes''.  
−
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon when activated
+
# Select from the following options, which are optional and which you can also change later:
−
##'''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...
+
##Check '''Tax Addon''' if the system should apply tax rules to this addon.
−
##'''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
+
##Check '''Show on Order''' if you want the addon to display during the initial order process. When you disable this, clients can only order the addon from an existing service. This can be useful for addons that you may not wish to offer right away on new signups. Unlike the Hidden or Retired options, this doesn't hide the addon from the client area and order form. It also doesn't completely prevent clients from ordering it.
−
##'''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.
+
##Check '''Suspend Parent Product''' to cause the system to suspend the parent product (to which the addon belongs) if the addon becomes overdue on payment, per your automation settings.
−
#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
+
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon on activation.
−
#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.
+
##'''Addon Weighting''' — By default, addons display on the order form alphabetically (an addon weighting value to 0). You can customize the display order by entering a weighting for each addon. For example, a value of 1 displays the addon at the top of the list, while an addon with a weighting of 2 displays beneath it.
−
# 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.<div class="docs-alert-info"><span class="title">Note</span><br />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.</div>
+
##Check '''Hidden''' to hide the addon on the order form. Clients can still order it using the direct order links and admins can continue to use it.
−
# When used with addons, '''Custom Fields''' are for internal use only and are typically auto-populated by modules.
+
##Check '''Retired''' to hide the addon from both admins and clients. The addon will not appear on the order form or as selectable in admin management. This will not change existing purchased addons.
−
#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.
+
#Under the '''Pricing''' tab, enter, in the prices for each of your activated currencies, setup fees to charge at the initial time of order only and recurring amounts to charge every cycle.
−
#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]].
+
#Under the '''Module Settings''' tab, if you'd like the addon to trigger provisioning, select a [[Server_Modules|Module Name]] to trigger when someone orders the addon.
−
Finally, click Save Changes
+
# Select a provisioning option to control when you'd like to activate this addon. You can do this as soon as someone places the order, when the first payment arrives, when you manually accept a pending order, or never.<div class="docs-alert-info"><span class="title">Note</span><br />In version 7.1 and earlier, a single ''Autoactivate on Payment'' option was available. In version 7.2 and above, we replaced this with four provisioning options.</div>
 +
# When you use this with addons, '''Custom Fields''' are for internal use only. Typically, modules auto-populate them.
 +
#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 appear during the ordering process for the selected products. To deselect a product , click its name in the ''Selected Products'' column.
 +
#If you select an '''Associated Download''', 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]].
 +
#Click Save Changes
  
 
===How Addons are Displayed===
 
===How Addons are Displayed===
−
Below is a table showing how the Show On Order, Hidden and Retired options affect addon display when enabled.
+
The table below shows how the Show On Order, Hidden, and Retired options affect addon display when you enable them.
  
 
<table class="table table-bordered">
 
<table class="table table-bordered">
Line 47: Line 50:
 
===Managing Addons===
 
===Managing Addons===
  
−
*To manage existing addons, go to '''Setup > Products/Services > Product Addons'''
+
To manage existing addons, go to '''Setup > Products/Services > Product Addons'''.
−
*From here you can view, edit and delete existing 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
+
*You can't 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===
 
===Assigning Addons to Customers===
  
−
*In addition to clients being able to order addons from the client area, admins can issue addons to customers
+
In addition to clients being able to order addons from the client area, admins can issue addons to customers. For more information, see [[Products Management#Addons|Products Management]].
−
*Refer to [[Products Management#Addons]] for details
 
  
 
==Configurable Options==
 
==Configurable Options==
−
Information on [[Configurable Options]] can be found on their own page.
+
For more information, see [[Configurable Options]].

Revision as of 19:58, 7 May 2020

Product Addons let you offer additional items which the client can enable or disable. The system will bill them seperately from the product. Configurable Options on products allow you to give your clients variables that alter the price of that product.

When should I use configurable options instead of addons?

  • If you want to offer a choice of options for a single item (for example, Disk Space, Operating Systems, or Locations).
  • If you want to bill the total amount as a single item and not seperately.
  • If 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-time service.
  • If clients can select the item independantly of other items.
  • If you want to bill it on its own cycle (for example, you could bill a dedicated IP address annually regardless of the package cycle).

Product Addons

Creating a New Addon

To create a new addon:

  1. Go to Setup > Products/Services > Product Addons > Add New
  2. Enter a Name and Description
  3. Click Save Changes.
  4. Select from the following options, which are optional and which you can also change later:
    1. Check Tax Addon if the system should apply tax rules to this addon.
    2. Check Show on Order if you want the addon to display during the initial order process. When you disable this, clients can only order the addon from an existing service. This can be useful for addons that you may not wish to offer right away on new signups. Unlike the Hidden or Retired options, this doesn't hide the addon from the client area and order form. It also doesn't completely prevent clients from ordering it.
    3. Check Suspend Parent Product to cause the system to suspend the parent product (to which the addon belongs) if the addon becomes 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 on activation.
    5. Addon Weighting — By default, addons display on the order form alphabetically (an addon weighting value to 0). You can customize the display order by entering a weighting for each addon. For example, a value of 1 displays the addon at the top of the list, while an addon with a weighting of 2 displays beneath it.
    6. Check Hidden to hide the addon on the order form. Clients can still order it using the direct order links and admins can continue to use it.
    7. Check Retired to hide the addon from both admins and clients. The addon will not appear on the order form or as selectable in admin management. This will not change existing purchased addons.
  5. Under the Pricing tab, enter, in the prices for each of your activated currencies, setup fees to charge at the initial time of order only and recurring amounts to charge every cycle.
  6. Under the Module Settings tab, if you'd like the addon to trigger provisioning, select a Module Name to trigger when someone orders the addon.
  7. Select a provisioning option to control when you'd like to activate this addon. You can do this as soon as someone places the order, when the first payment arrives, 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, we replaced this with four provisioning options.
  8. When you use this with addons, Custom Fields are for internal use only. Typically, modules auto-populate them.
  9. 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 appear during the ordering process for the selected products. To deselect a product , click its name in the Selected Products column.
  10. If you select an Associated Download, 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.
  11. Click Save Changes

How Addons are Displayed

The table below shows how the Show On Order, Hidden, and Retired options affect addon display when you enable them.

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 can't delete an addon if it is in use by customers.

Assigning Addons to Customers

In addition to clients being able to order addons from the client area, admins can issue addons to customers. For more information, see Products Management.

Configurable Options

For more information, see Configurable Options.

Retrieved from "http://3.17.75.209/index.php?title=Product_Addons&oldid=28424"