Difference between revisions of "Product Addons"

From WHMCS Documentation

(Product Addons billing cycle workflow)
(Creating a New Addon)
Line 38: Line 38:
 
To create a new addon:
 
To create a new addon:
  
#Go to '''Setup > Products/Services > Product Addons > Add New'''
+
#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons > Add New'''.
#Enter a '''Name''' and '''Description'''
+
#Enter a '''Name''' and '''Description'''.
 
# Click ''Save Changes''.  
 
# Click ''Save Changes''.  
 
# Select from the following options, which are optional and which you can also change later:
 
# Select from the following options, which are optional and which you can also change later:
 
##Check '''Tax Addon''' if the system should apply tax rules to this addon.
 
##Check '''Tax Addon''' if the system should apply tax rules to this addon.
##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.
+
##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.
 
##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.
 
##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.
 
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon on activation.
 
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon on activation.
Line 51: Line 51:
 
#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.
 
#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.
 
#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.
 
#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.
# 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>
+
# 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.
 
# 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.
+
#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]].
+
#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'''). For more information, refer to [[Product Download Distribution]].
#Click Save Changes
+
#Click '''Save Changes'''.
  
 
===How Addons are Displayed===
 
===How Addons are Displayed===

Revision as of 13:36, 4 August 2020

What are Addons and Configurable Options?

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

  • Configurable options are defined in groups
  • Groups of options can then be applied to one or more products

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 separately
  • When the billing cycle of the addon must 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 its own cycle - eg. an SSL certificate 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 billing cycle workflow

If the Product Addon has a billing cycle configured in the pricing matrix which matches the parent product in the cart, then matching billing cycle will be used automatically. If a product addon is ordered at a later date via the client area (Services > View Available Addons) it can have a different billing cycle and next due date from the parent product.

For some addons such as SSL certificates, you may wish to ensure this is billed annually regardless of the parent product billing cycle, to do this you should only specify annual pricing for addon in the addon pricing matrix.

To set annual pricing on the addon:

  1. Navigate to Configuration () > System Settings > Products/Services > Product Addons.
  2. Click Edit next to the addon.
  3. Click Pricing.
  4. Enable the annual pricing and set the desired selling price.

This will ensure the addon is always billed annually even if the parent product billing cycle is different.

Product Addons

Creating a New Addon

To create a new addon:

  1. Go to Configuration () > System Settings > 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). 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.