Billing Cycles
Clientexec 6.2.0 introduces a new Billing Cycles section, which allows the admins to configure custom billing cycles to be used throughout the application.
Manage billing cycles permission
In order for an admin to be able to use this new section, it requires to be either a Super Admin or having enabled the new admin permission Manage billing cycles .
To configure the permission:
- go to Settings > Users > Staff Management
- click on a Staff Role name, then select Edit Permissions
- go to Admin Permissions > View Billing Setup > Manage billing cycles
- after enabling the permission, do not forget to click the Update Permissions button
Billing Cycles section
The new Billing Cycles section allows admins to add, edit, and delete billing cycles.
This section can be located at:
- Settings > Billing > Billing Cycles
In the new Billing Cycles section, there is a list of all the available billing cycles that were introduced by default with the installer, as well as the options to add, edit and delete billing cycles.
One Time billing cycle
There is an especial billing cycle that is not like the others.
By default, this billing cycle is named One Time and it can never be deleted but it can be renamed if required but taking into account that the name will appear on invoices and several places related to billing.
The One Time billing cycle is used for:
- one time payment price for products
- setup price for addons
- non-recurring charges
Add Billing Cycle
In order to add a new billing cycle, click on the Add Cycle button and the following popup will appear:
- Name
- Avoid using duplicated names to avoid confusion
- Recommended names are the number of the Amount of Units , followed by a single space character, followed by the name of the Time Unit starting with uppercase. This will help the translation system to translate the new custom billing cycle name to other languages, but any name can be used. Examples: 1 Day, 2 Days, 1 Week, 2 Weeks, 1 Month, 2 Months, 1 Year, 2 Years
- Time Unit
- Days : stored in the database as d
- Weeks : stored in the database as w
- Months : stored in the database as m
- Years : stored in the database as y
- Amount of Units
- The value should be a positive integer number representing how many Time Units it will be using
Every billing cycle is a unique combination of Time Unit and Amount of Units .
Attempting to submit a combination that already exists will be ignored .
Edit Billing Cycle
In order to edit an existing billing cycle, click on the billing cycle name and the same popup like the one for Add Billing Cycle will appear, displaying the current configuration of that billing cycle.
Delete Billing Cycle
Select the billing cycles to be deleted by checking their respective check-boxes, then, click Delete button.
Attempting to delete the One Time billing cycle will be ignored.
If a billing cycle is in use (there are Recurring Fees using it), it can not be deleted.
Coupons
When configuring a coupon, please take into account that the field **Duration (months)** should be used only for Billing Cycles which have their Time Unit in Months or Years .
The value should be an integer number representing how many months it will be recurring.
Products
Products of any type will have available the One Time billing cycle.
Products of type Domain and their respective Addons will only be able to use billing cycles that have their Time Unit in Years , and the One Time billing cycle.
Products of type SSL will only be able to use billing cycles that have their Time Unit in Years , and the One Time billing cycle.
When configuring a product, please take into account that the field Prorate To Day and Include Following Payment should be used only for Billing Cycles which have their Time Unit in Months or Years .
Addons
Products of type Domain and their respective Addons will only be able to use billing cycles that have their Time Unit in Years , and the One Time billing cycle.
Recurring Fees
When configuring a recurring fee, please take into account that the field Duration in months should be used only for Billing Cycles which have their Time Unit in Months or Years .
The value should be an integer number representing how many months it will be recurring.
Order New Service
When using a Direct Link to allow placing direct orders for a new product or service, it is possible to indicate in the Direct Link the billing cycle wanted to be used, with the GET parameter paymentterm , using either the billing cycle id or a value representing the billing cycle .
In Example, 15 days can be either 15d or d15, 1 week can be either 1w or w1, 3 months can be either 3m or m3, 2 years can be either 2y or y2, etc.
Updating custom Plugins or code
If having custom plugins or code , that is making use of billing cycles, please take a look here for more details about how to proceed.
Manage billing cycles permission
In order for an admin to be able to use this new section, it requires to be either a Super Admin or having enabled the new admin permission Manage billing cycles .
To configure the permission:
- go to Settings > Users > Staff Management
- click on a Staff Role name, then select Edit Permissions
- go to Admin Permissions > View Billing Setup > Manage billing cycles
- after enabling the permission, do not forget to click the Update Permissions button
Billing Cycles section
The new Billing Cycles section allows admins to add, edit, and delete billing cycles.
This section can be located at:
- Settings > Billing > Billing Cycles
In the new Billing Cycles section, there is a list of all the available billing cycles that were introduced by default with the installer, as well as the options to add, edit and delete billing cycles.
One Time billing cycle
There is an especial billing cycle that is not like the others.
By default, this billing cycle is named One Time and it can never be deleted but it can be renamed if required but taking into account that the name will appear on invoices and several places related to billing.
The One Time billing cycle is used for:
- one time payment price for products
- setup price for addons
- non-recurring charges
Add Billing Cycle
In order to add a new billing cycle, click on the Add Cycle button and the following popup will appear:
- Name
- Avoid using duplicated names to avoid confusion
- Recommended names are the number of the Amount of Units , followed by a single space character, followed by the name of the Time Unit starting with uppercase. This will help the translation system to translate the new custom billing cycle name to other languages, but any name can be used. Examples: 1 Day, 2 Days, 1 Week, 2 Weeks, 1 Month, 2 Months, 1 Year, 2 Years
- Time Unit
- Days : stored in the database as d
- Weeks : stored in the database as w
- Months : stored in the database as m
- Years : stored in the database as y
- Amount of Units
- The value should be a positive integer number representing how many Time Units it will be using
Every billing cycle is a unique combination of Time Unit and Amount of Units .
Attempting to submit a combination that already exists will be ignored .
Edit Billing Cycle
In order to edit an existing billing cycle, click on the billing cycle name and the same popup like the one for Add Billing Cycle will appear, displaying the current configuration of that billing cycle.
Delete Billing Cycle
Select the billing cycles to be deleted by checking their respective check-boxes, then, click Delete button.
Attempting to delete the One Time billing cycle will be ignored.
If a billing cycle is in use (there are Recurring Fees using it), it can not be deleted.
Coupons
When configuring a coupon, please take into account that the field **Duration (months)** should be used only for Billing Cycles which have their Time Unit in Months or Years .
The value should be an integer number representing how many months it will be recurring.
Products
Products of any type will have available the One Time billing cycle.
Products of type Domain and their respective Addons will only be able to use billing cycles that have their Time Unit in Years , and the One Time billing cycle.
Products of type SSL will only be able to use billing cycles that have their Time Unit in Years , and the One Time billing cycle.
When configuring a product, please take into account that the field Prorate To Day and Include Following Payment should be used only for Billing Cycles which have their Time Unit in Months or Years .
Addons
Products of type Domain and their respective Addons will only be able to use billing cycles that have their Time Unit in Years , and the One Time billing cycle.
Recurring Fees
When configuring a recurring fee, please take into account that the field Duration in months should be used only for Billing Cycles which have their Time Unit in Months or Years .
The value should be an integer number representing how many months it will be recurring.
Order New Service
When using a Direct Link to allow placing direct orders for a new product or service, it is possible to indicate in the Direct Link the billing cycle wanted to be used, with the GET parameter paymentterm , using either the billing cycle id or a value representing the billing cycle .
In Example, 15 days can be either 15d or d15, 1 week can be either 1w or w1, 3 months can be either 3m or m3, 2 years can be either 2y or y2, etc.
Updating custom Plugins or code
If having custom plugins or code , that is making use of billing cycles, please take a look here for more details about how to proceed.
Updated on: 27/02/2023
Thank you!