Difference between revisions of "Addons and Configurable Options"

From WHMCS Documentation

(Setting up a New Group)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
===What are Addons and Configurable Options?===
+
WHMCS has two distinct methods for configuring additional items for purchase with a main product: product addons and configurable options. The method you choose will depend on the specifics of your offerings. Configurable options on products allow you to give your clients ways to alter the price of that product while product addons do not.  
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
+
== Configurable Options ==
*Groups of options can then be applied to one or more products
 
  
===When should I use configurable options instead of addons?===
+
Use [[Configurable Options]] when:
  
*If you want to offer a choice of options for a single thing - for example Disk Space, Operating System, Locations, etc...
+
*You want to offer a choice of options for a single item.
*If you want the total amount to be billed as a single item and not separately
+
*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
+
*The billing cycle of the addon must match the billing cycle of the product.
  
===When should I use addons instead of configurable options?===
+
Configurable options are the best method for, for example, selling options like disk space or the choice of an operating system.
  
*If the item is a one-off service
+
You can work with configurable options at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Configurable Options]]''', or, prior to WHMCS 8.0, '''Setup > Products/Services > Configurable Options'''.
*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 ==
  
===Product Addons billing cycle workflow===
+
Use [[Product Addons]] when:
  
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.
+
* The item is a one-time service.
 +
* You want customers to select it independently of other items.
 +
* You want the option of billing on the item's own cycle. For example, an SSL certificate might be billed annually regardless of the package cycle.
 +
* In WHMCS 8.1 and earlier, the item is not subject to prorata at a product level or client-wide signup anniversary prorata. (In WHMCS 8.2 and later, you can choose to use prorata billing with addons.)
  
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.
+
Product addons are the best method for, for example, selling SSL certificates or dedicated IP addresses.
 
+
To set annual pricing on the addon:
+
You can work with product addons at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Product Addons]]''', or, prior to WHMCS 8.0, '''Setup > Products/Services > Product Addons'''.
 
 
#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons'''.
 
#Click '''Edit''' next to the addon.
 
#Click '''Pricing'''.
 
#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.
 
 
 
==Configurable Options==
 
===Setting up a New Group===
 
 
 
#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Configurable Options > Create a New Group'''.
 
#Enter a name and description (for admin reference only) and choose the products it applies to (you can also do this later).
 
#Click '''Save Changes'''. The page will reload showing the group details and allowing you to move on to managing options.
 
 
 
===Managing Options===
 
 
 
To manage options:
 
 
 
#Go to '''Setup > Products/Services > Configurable Options''' and click the edit icon next to the option group you want to modify. At the top of the page, you can edit the name, description, and assigned products.
 
#To add a new configurable option, click '''Add New Configurable Option'''.
 
#A new window will allow you to enter an option name and choose a type. You can select from the following types:
 
#*'''Dropdown''' — Show a menu of options on the order form.
 
#*'''Radio''' — Show a selection of radio button options on the order form.
 
#*'''Yes/No''' — Show a checkbox on the order form that allows the client to turn the option on or off.
 
#*'''Quantity''' — Show an input field on the order form that allows the user to enter an item quantity.
 
#Enter the first sub-option value you want to offer for this option (you can set the price after saving).
 
#Click '''Save Changes'''. The page will refresh with the sub-option showing pricing fields.
 
#Enter pricing for all the cycles that the product has enabled.
 
#*If you selected '''Yes/No''' or '''Quantity''' for the type, then only one sub-option is necessary.
 
#*If you selected '''Dropdown''' or '''Radio''' for the type, use the '''Add Option''' field at the bottom of the page to add multiple sub-options.
 
#After every addition, click '''Save Changes''' to reload the page and set the new sub-options pricing.
 
#After you finish configuring your options, click '''Close Window'''. This will refresh the underlying page to show the new option.
 
#Repeat this process for each option you want to add.
 
#After you set up multiple options in the group, use the '''Sort Order''' column to define the display order for the options.
 
#Click '''Back to Groups List''' to complete the process.
 
 
 
====Option Types====
 
WHMCS offers a variety of different configurable option types, allowing for choice of the most appropriate input format:
 
 
 
=====Dropdown=====
 
[[File:Co dropdown.png|right]]
 
The '''Dropdown''' option type displays a standard combo box. This is useful when there are a large number of items to choose from that should require minimal space on the order form.
 
 
 
=====Yes/No=====
 
[[File:Co yesno.png|right]]
 
The '''Yes/No''' option type displays a checkbox for the client to select or deselect. This is useful for simple opt-in-or-opt-out questions. Both yes or no are valid values, so the form validation will accept the unchecked state even if this is a required option.
 
 
 
=====Radio=====
 
[[File:Co radio.png|right]]
 
The '''Radio''' option type displays a list of the available options alongside a radio box for the client to choose from. If there are too many options, this can look messy. In that case, we recommend using '''Dropdown''' instead.
 
 
 
=====Quantity=====
 
[[File:Co quantity.png|right]]
 
The '''Quantity''' option type displays a field that allows the client to enter a number. Specify the unit price in the One Time/Monthly column. The system will multiply it by the quantity that the client selected.
 
 
 
When creating or editing a '''Quantity''' option, you can set maximum and minimum vales. You may also allow clients to enter any quantity by leaving '''both''' the 'Minimum' and 'Maximum' fields blank. However, you can't specify just a minimum or just a maximum value.
 
 
 
=====Slider=====
 
 
 
[[File:OrderFormConfigOptionsSliderNew1.png]]
 
 
 
The slider provides a graphical method for clients to specify a quantity. Like the '''Quantity''' option type, you must supply a minimum and maximum quantity and use it in conjunction with all order form templates (except Boxes).
 
 
 
===Hiding Options===
 
 
 
Hiding is useful for when you want to remove an option that you no longer offer to new signups from the order forms, but don't want to lose the selections for existing customers.
 
 
 
You can hide entire configurable options or just individual sub-options. Do this in the managing options screen by checking the Hidden/Hide box for an option you want to disable.
 
 
 
'''Important Note:''' Once you hide an option or sub-option, admin users continue to see it for existing customers.
 
 
 
'''Note:''' As of version v5.3 and above, the "Starting From" price on cart.php in the Modern order form template doesn't include hidden configurable options. Prior to this, the price included hidden configurable options.
 
 
 
===Friendly Display Names===
 
Sometimes, a module may require you to format a configurable option valu in a certain way, but this might be difficult for visitors to understand. WHMCS can display a friendly name to visitors on the order form, emails, and invoices, but still send the required machine code to the module.
 
[[File:Config option friendly.png|thumb|Config Option Friendly Names]]
 
To achieve this, use the format "required value|display value". For example:
 
 
 
*Disk Space|Your Web Quota
 
*10000MB|10 Gigabytes
 
*rbx01ssd|French Server - Solid State Drive
 
 
 
===Product Addons===
 
For information about product addons, see [[Product Addons]].
 

Latest revision as of 20:13, 16 November 2022

WHMCS has two distinct methods for configuring additional items for purchase with a main product: product addons and configurable options. The method you choose will depend on the specifics of your offerings. Configurable options on products allow you to give your clients ways to alter the price of that product while product addons do not.

Configurable Options

Use Configurable Options when:

  • You want to offer a choice of options for a single item.
  • You want the total amount to be billed as a single item and not separately.
  • The billing cycle of the addon must match the billing cycle of the product.

Configurable options are the best method for, for example, selling options like disk space or the choice of an operating system.

You can work with configurable options at Configuration () > System Settings > Configurable Options, or, prior to WHMCS 8.0, Setup > Products/Services > Configurable Options.

Product Addons

Use Product Addons when:

  • The item is a one-time service.
  • You want customers to select it independently of other items.
  • You want the option of billing on the item's own cycle. For example, an SSL certificate might be billed annually regardless of the package cycle.
  • In WHMCS 8.1 and earlier, the item is not subject to prorata at a product level or client-wide signup anniversary prorata. (In WHMCS 8.2 and later, you can choose to use prorata billing with addons.)

Product addons are the best method for, for example, selling SSL certificates or dedicated IP addresses.

You can work with product addons at Configuration () > System Settings > Product Addons, or, prior to WHMCS 8.0, Setup > Products/Services > Product Addons.