Difference between revisions of "Configurable Options"

Revision as of 21:34, 18 February 2022

Configurable Options allow you to give your clients variables which alter the price of that product. You can define them in groups that you can then apply to one or more products.

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

When to Use Configurable Options

Depending on your purpose, you may wish to use product addons or you may wish to use configurable options. Configurable options on products allow you to give your clients ways to alter the price of that product while product addons do not.

Use Configurable Options when:

You want to offer a choice of options for a single item, like disk space, the server operating system, or locations.
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.

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.)

For more information about product addons, see Product Addons.

Configurable Option Groups

All configurable options exist within a configurable option group. You must create at least one group before you can create and manage any configurable options.

Set Up a New Group

To set up a new group of configurable options:

Click Create a New Group.
Enter a name and description. Only admins will see these.
Choose the products that the group applies to.
Click Save Changes.

The page will reload showing the group details and allowing you to move on to managing options.

Manage Groups

To edit a group:

Click the edit icon for the desired group.
Make the desired updates to the name, description, and assigned products.
Click Save Changes.

Adding and Managing Options

To add and manage a group's options:

Click the edit icon next to the desired option group.
Click Add New Configurable Option. A new window will appear.
Enter an option name.
Choose a type. For more information on each type, see the sections below.
Enter the first sub-option you want to offer for this option.
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 Add Option at the bottom of the page to add multiple sub-options.
Add all of the desired 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.
To change the order in which the sub-options appear, enter the priority of each option in the Sort Order setting.
To hide a sub-option, select Hidden. For more information, see #Hiding_Options Hiding Options below.
Click Save Changes.
Click Back to Groups List.

Option Types

WHMCS offers a variety of different configurable option types, allowing for choice of the most appropriate input format:

Dropdown

Dropdown displays a menu of options on the order form. This is useful when there are a large number of items to choose from that should require minimal space on the order form.

Radio

Radio displays a list of the available options with a radio button for the client to choose from.

If you will have a large number of options, we recommend using Dropdown instead for a better appearance.

Yes/No

Yes/No 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.

Quantity

Quantity displays a field that allows the client to enter a number. When you configure this type, specify the unit price in One Time/Monthly. The system will multiply it by the quantity that the client selected.

When creating or editing Quantity, you can set maximum and minimum vales. You may also allow clients to enter any quantity by leaving both Minimum and Maximum blank. However, you can't specify just a minimum or just a maximum value.

Slider

The slider provides a graphical method for clients to specify a Quantity. Note that Slider is not an option type itself. In order to use the slider, you must select the Quantity option type and supply both a minimum and maximum value. Once you have set both values, the slider will automatically appear in 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.

After you hide an option or sub-option, admin users continue to see it for existing customers.

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 value 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.

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

@@ Line 1: / Line 1: @@
-#REDIRECT [[Addons_and_Configurable_Options]]
+Configurable Options allow you to give your clients variables which alter the price of that product. You can define them in groups that you can then apply to one or more products.
+You can add and manage 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'''.
+== When to Use Configurable Options ==
+Depending on your purpose, you may wish to use product addons or you may wish to use configurable options. Configurable options on products allow you to give your clients ways to alter the price of that product while product addons do not.
+Use Configurable Options when:
+*You want to offer a choice of options for a single item, like disk space, the server operating system, or locations.
+*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.
+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.)
+For more information about product addons, see [[Product Addons]].
+== Configurable Option Groups ==
+All configurable options exist within a configurable option group. You must create at least one group before you can create and manage any configurable options.
+=== Set Up a New Group ===
+To set up a new group of configurable options:
+# Click '''Create a New Group'''.
+# Enter a name and description. Only admins will see these.
+# Choose the products that the group applies to.
+# Click '''Save Changes'''.
+The page will reload showing the group details and allowing you to move on to managing options.
+=== Manage Groups ===
+To edit a group:
+# Click the edit icon for the desired group.
+# Make the desired updates to the name, description, and assigned products.
+# Click '''Save Changes'''.
+== Adding and Managing Options ==
+To add and manage a group's options:
+# Click the edit icon next to the desired option group.
+# Click '''Add New Configurable Option'''. A new window will appear.
+# Enter an option name.
+# Choose a type. For more information on each type, see the sections below.
+# Enter the first sub-option you want to offer for this option.
+# 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 '''Add Option''' at the bottom of the page to add multiple sub-options.
+# Add all of the desired 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.
+# To change the order in which the sub-options appear, enter the priority of each option in the '''Sort Order''' setting.
+# To hide a sub-option, select '''Hidden'''. For more information, see [[#Hiding_Options Hiding Options]] below.
+# Click '''Save Changes'''.
+# Click '''Back to Groups List'''.
+====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]]
+'''Dropdown''' displays a menu of options on the order form. This is useful when there are a large number of items to choose from that should require minimal space on the order form.
+=====Radio=====
+[[File:Co radio.png|right]]
+'''Radio''' displays a list of the available options with a radio button for the client to choose from.
+If you will have a large number of options, we recommend using '''Dropdown''' instead for a better appearance.
+=====Yes/No=====
+[[File:Co yesno.png|right]]
+'''Yes/No''' 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.
+=====Quantity=====
+[[File:Co quantity.png|right]]
+'''Quantity''' displays a field that allows the client to enter a number. When you configure this type, specify the unit price in '''One Time/Monthly'''. The system will multiply it by the quantity that the client selected.
+When creating or editing '''Quantity''', you can set maximum and minimum vales. You may also allow clients to enter any quantity by leaving both '''Minimum''' and '''Maximum''' 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'''. Note that '''Slider''' is not an option type itself. In order to use the slider, you must select the '''Quantity''' option type and supply '''both''' a minimum and maximum value. Once you have set both values, the slider will automatically appear in 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.
+After you hide an option or sub-option, admin users continue to see it for existing customers.
+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 value 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

Documentation