Personal tools
Namespaces

Variants
Actions

Product Free Trial Manager For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Settings)
(→‎Management)
Line 168: Line 168:
 
|}
 
|}
  
−
==Excluded Users==
+
==Products==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In the '' 'Excluded Clients' '' section, you can list clients who will be skipped when validating the gateway rules.<br/>
+
|style="padding: 10px 0px 15px 15px;"|In the '' 'Products' '' section, you can list clients who will be skipped when validating the gateway rules.<br/>
 
Add clients to the list.
 
Add clients to the list.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 25px;"|[[File:PGS_9_3.png]]
+
|style="padding: 0px 0px 15px 25px;"|[[File:PTM_9_3.png]]
 
|}
 
|}
 
{|
 
{|
Line 180: Line 180:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_9_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PTM_9_4.png]]
 
|}
 
|}
  
−
==Gateway Switches==
+
==Email Reminders==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'' 'Gateways Switches' '' tab allows you to define switching rules per payment gateway.<br/>
+
|style="padding: 10px 0px 15px 15px;"|'' 'Email Reminders' '' tab allows you .............
−
You will find there a list of all active gateways in your system.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_10.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:PTM_10.png]]
−
|}
+
−
===Creating New Switching Rules===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|In order to limit access to a selected payment gateway, press '' '+' '' button. <br/>
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_10_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Select a country and states ''(optional).'' The gateway will be available for clients who do purchases in that region only.
+
−
Press '' 'Add' '' to complete.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_11.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Repeat the process for all gateways you wish to limit. <br/>
+
−
Use action buttons to edit rules or delete them.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_12.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Perform the above steps for all active gateways that you wish to use. You may add rules per single gateway manually or copy rules from another gateway.<br/> To do so, simply press marked button and choose teh geteway whose rules you are going to copy. Remember to save the changes when ready.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|Edit the rule, to move to the gateway settings.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_12_3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|There define the gateway rules type:
+
−
*'''Allowed''' - gateway by default is locked, after adding any rules within this gateway, it will become unlocked for clients who meet the rules
+
−
*'''Blocked''' - gateway  by default remains unlocked, after adding rules the gateway becomes blocked for adequate clients.<br/> For example check: [[#Payment_Gateways_On_The_Order_Form|Case Four]].<br/>
+
−
Define the invoice threshold per enabled currency, provide the invoice value and mark '' 'Greater' '' or '' 'Lower' '' to specify the rule performance. <br/>
+
−
Remember to save the changes.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_12_4.png]]
+
−
|}
+
−
 
+
−
<!--
+
−
===Modify Switching Rules===
+
−
{|
+
−
|style="padding: 10px 0px 20px 15px;"|In order to modify switching rules, expand the desired payment gateway configuration by pressing it.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Configuration on the following screen allows this gateway to be used from United Kingdom and two states of the US - California and Texas.<br />
+
−
Both the country and the state in each configuration are modifiable.<br />
+
−
Select a desired option and press '' 'Save Changes'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|To move a rule to a different gateway, press '' 'Change Gateway', '' select the desired gateway and press '' 'Save Configuration'. ''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_14_1.png]]
+
−
|}
+
−
-->
+
−
 
+
−
===Payment Gateways On The Order Form===
+
−
{|
+
−
|style="padding: 10px 0px 15px 15px;"|Payment Gateway Allocator For WHMCS affects only client area. Let's take a look how the addon affects the payments process.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Case One:'''<br/>
+
−
'' 'Credit Card Per Country / State' '' and  '' 'Redirect Per Country / State' '' payment methods have been activated.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_13.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Setting' ''  section option '' 'Module Gateway Only' '' has been selected together with two default gateways for '' 'Credit Card' '' and '' 'Redirection' '' payments.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_14.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Consequently, client may now choose only between:
+
−
*'' 'Pay With Credit Card' '' option - in our case it will be '' 'SecurePay' '' gateway.
+
−
*'' 'Proceed To Payment' '' option - in our case it will be '' '2CheckOut' '' gateway.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_15.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Case Two:'''<br/>
+
−
In another scenario, in '' 'Settings' '' section of the module '' 'Apply Switching Rules' '' option is selected.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_15_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|In '' 'Gateway Switches' '' section, there is a rule forcing clients from United States to pay with '' '2CheckOut' '' payment gateway.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_15_2.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Consequently, client Test Tester, who is from USA, has no choice, but to pay with the enforced by the admin payment gateway.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_15_3.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Case Three:'''<br/>
+
−
To allow all gateways in the client area, proceed to the addon → '' 'Settings' '' page and clear the settings. <br />
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_16.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Let's check payment options in the client area once again. Now, your clients are able to pay using every active payment gateway. <br/>
+
−
However, when selecting '' 'Pay With Credit Card' '' or '' 'Proceed To Payment' '' option, client will be redirected to a gateway keeping any switching rules.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_17.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|If you wish to hide only part of the gateways, for example only those for which switching rules are set, proceed to '' 'Setup' '' → '' 'Payments' '' → '' 'Payment Gateways'. ''<br />
+
−
Afterwards, uncheck '' 'Show On Order Form' '' checkbox next to the desired gateway and press '' 'Save Changes'. '' Repeat this step for each gateway you wish to hide from the client area.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_18.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Case Four:'''<br/>
+
−
'' 'Authorize.net' '' gateway is marked as 'Allowed' for added rules.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_19_1.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|Taking into account the above gateways settings and rules, a client from USA is allowed to choose among three gateways as visible on the screen below:
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PGS_20.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|The same settings and rules bring following consequences for a client from Russian Federation, that is, such client is allowed to use only one payment gateway.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:PGS_21.png]]
+
 
|}
 
|}
 +
==Logs
  
 
=Tips=
 
=Tips=

Revision as of 12:58, 8 August 2022

Contents

About Product Free Trial Manager For WHMCS

Product Free Trial Manager For WHMCS allows you to activate a dedicated payment gateway for free trial access for all or single products in your offer.
Let your clients test your products by offering them free of charge, but limited in time, access to the ordered products, and make a well-thought decision to avoid cancellations and misunderstandings.

Use the module to make your offer even more competitive and much practical to your clients.

  • Features:
✔
✔
✔
✔
✔
✔
✔
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 7.2 Up To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.1 And Later
✔ Easy Module Upgrade To Open Source Version

Installation

This tutorial will show you how to successfully install and configure Product Free Trial Manager For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to our client area and download the module.
PTM 1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

PTM 2.png
3. When installing Product Trial Manager For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'your_whmcs/modules/addons/ProductFreeTrialManager/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

PTM 3.png
4. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

PTM 4.png
5. Now, set up the 'storage' folder as recursively writable.

This folder is available at 'your_whmcs/modules/addons/ProductFreeTrialManager/'.

PTM 5.png

Configuration of Addon

6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'System Settings' → 'Addon Modules'. Afterwards, find 'Product Free Trial Manager' and press the 'Activate' button.

PTM 6.png
7. In the next step you need to permit access to this module.

To do so, click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

PTM 7.png

Additional Steps Required

8. Now, proceed to 'System Settings' → 'Payment Gateways' → 'All Payment Gateways'

Find the 'Product Free Trial Manager' gateway and activate it.

PTM 8.png
9. Afterwards, move to 'Manage Existing Gateways' to add your custom display name. Press 'Save Changes'.

The gateways will be available to choose as a payment method for clients depending on the configuration in the Product Free Trial Manager addon.

PTM 9.png
9. Congratulations, you have just successfully installed Product Free Trial Manager For WHMCS!

You can now access your module from 'Addons' → 'Product Free Trial Manager'.

PTM 10.png

Management

In this section we will show you the possibilities of Product Free Trial Manager For WHMCS.

Our module allows you to ...........

Settings

At the 'Settings' tab you can set up the module's behavior. Configure free trial access settings and cron tab behavior.
PTM 9.png
At the 'Cron Settings' tab you can set up the crons behavior.
PTM 10.png
In 'Gateway Settings' select whether you want to allow:
  • Trial Period - Enter the number of days for how long the ordered product will remain active. After the specified time, the product will be suspended.
  • Products Limit In Cart - Enter the maximum number of products that a client may add to the cart and apply free trial access
  • One Trial Per Product - If enabled, only one trial access per product may be ordered
  • One Trial Per Customer - If enabled, a customer may order only one product with trial access
  • New Customers Only - If enabled, only customers who do not have any orders yet will be allowed to select the trial payment method
  • Hide Trial Payment Method - If trial access is not available for a product, this payment gateway will be hidden for clients
  • Email Reminders Per Service - If enabled, a separate email reminder will be sent per every active trial service
  • Custom Landing Page - Enter the URL to which the customer will be redirected after completing the trial order. If left empty, clients will be redirected to the invoice by default.
File:PTM 9 1.png

Products

In the 'Products' section, you can list clients who will be skipped when validating the gateway rules.

Add clients to the list.

File:PTM 9 3.png
Choose a clients from the list. Add client one by one.
File:PTM 9 4.png

Email Reminders

'Email Reminders' tab allows you .............
PTM 10.png

==Logs

Tips

1. xxx

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Product_Free_Trial_Manager_For_WHMCS&oldid=60079"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Product Free Trial Manager For WHMCS