Guide: CAN Paywall Configuration
Paywall feature allows the Captive Users without any active plans to buy the plan according to their need. To use the Paywall feature, the Planset must be created in the Portal tab of the Admin Portal by the Admin. Once a Planset is created, this can be associated with the user when creating the user in the Users tab.
The Paywall feature is available only for the Organizations that have enabled it. To enable the Paywall feature, please contact your respective System Administrator / Account Manager.
The following steps have to be completed to use the Paywall feature:
Stripe Configurations
Admin Portal Configurations
Creation of Planset in the Admin Portal
Associate the planset with the user account when creating the user (Only applicable for Admin created users)
User Portal Configurations - Buy the required plan in the User Portal.
Stripe Configurations
The required Stripe configurations will be done by the Kognitive Operations Team. Users can start from the Admin Portal configurations.
Admin Portal Configurations
The following configurations are done by the Administrator in the CAN Administration Portal.
1. Create the Required Plans in Plans Tab
Select the Add New Plan button from the Plans tab.
Enter the required plan details such as Plan Name, Quota and Duration.
In the Payable Plan field, select the Yes radio button. Only the plans configured as Payable plans can be added in the Planset.
In the Price field, enter the required price of the plan.
If the plan should be free of cost, enter 0 in the Price field.
The Payable Plan and Price fields are only available for the Organizations that have enabled the Paywall feature. To enable the Paywall feature, please contact your respective Account Manager.
Click Submit button to save the plan.
Create all the required plans that should be displayed to the user as their options.
2. Creating the Planset in Portal Tab
Select the Portal tab from the Captive Access Network Homepage.
Select the Plans Page option from the side bar to create the Planset.
Set the Welcome Message. The welcome message will be displayed in the Available Plans tab for the Paywall enabled organizations.
Set the Post Login Page Message. This message will be displayed when the user successfully logs in into his account. The Admin can view the preview of the setup in real-time in the right panel.
The Plan(s) - for Admin created Users section is used to create the Plansets that can be associated with the Admin Created Users. This feature can only be used by Paywall enabled organizations. Plansets enable the end user to buy the plan according to their need. Once a Planset is created, this can be associated with the user account when creating the user in the Users tab.
Enter a Name for the Planset.
In the Plan(s) field, select the plans that should be displayed to the end user as their options. Only the plans configured as Payable plans will be allowed to be added in the Planset.
When multiple plans are selected, all the selected plans will be shown to the user while logging in and the user can buy the plan of their choice.
The Plan(s) - for Self Sign Up Users section is used to create the Planset that will be associated with the Self Sign Up Users. This feature can only be used by Paywall enabled organizations. Plansets enable the self sign up user to buy the plan according to their need. Once a Planset is created, this will be associated with all the self sign up users automatically when they sign up.
In the Plan(s) field, select the plans that should be displayed to the self signed up user as their options to buy. Only the plans configured as Payable plans will be available in the dropdown menu.
When multiple plans are selected, all the selected plans will be shown to the end user while logging in and the user can buy the plan of their choice.
Click the Save button to save the configurations.
3. Associating Planset with the User - Admin Created User
When creating a user account from the Users tab, select the name of the Planset in the Select Plan field.
Click Submit to save the changes.
Now when the user logs into their account, they will have the option to buy any one of the plan from the selected Planset.
4. Associating Planset with the User - Self Sign Up User
When a self sign up user logs into their account, they will have the option to buy any one of the plans that the admin has already configured for Self sign up users.
User Portal Configurations
The end users that are associated with the Planset can log in to the User Portal and buy their plan as per their requirement.
Login to the User Portal with valid credentials. The user is welcomed with the following screen.
Select Ok button.
Select the Available Plans tab. Proceed to select the required plan by comparing the plan details.
Select the Purchase button of the required plan.
The user is redirected to the checkout screen.
Follow the on screen instructions to and complete the payment.
When the payment is successfully completed, the following success message is shown to the user.
The selected plan can be seen under the Active Plans tab.
The user will not be allowed to purchase another plan when the current plan is active.
The admin can view the log of all purchase events done by the users.
Select the Events tab from the Homepage of the Admin Portal.
Select the Purchase tab.
Select the Custom Search radio button and select the required time period.
The table shows all the Purchase Events occurred during the selected time period.
Refunds
The admin can raise refund requests for the user transactions if needed. The user must provide the details of the their transaction to the admin to raise the refund request.
The admin must follow the below steps to request a refund:
Collect the payment details from the end user.
Open the Admin Portal and select the Users tab.
Find the required user using the username.
Select the Actions icon under the Actions column. The Actions dialog box opens.
Select the Purchase History option from the side bar.
Find the Purchase ID of the payment transaction that needs to be refunded from the Purchase ID column.
The admin can initiate the refund from the corresponding Stripe account using the Purchase ID and the refund will be credited to the payment source account of the end user.