Administration

Plan creation

Plans in PayPlans provide control on user's access of website. Let us learn how to create and use it.[br] To create plan of different types, like- Fixed Plan ( requires One Time payment ), Recurring Plans ( requires multiple repeating payments), Forever, Trail + Recurring and Trial2 + Recurring plan then go to PayPlans->Plan. Below are the steps to create new plan in PayPlans are as follow-

  1. Go to PayPlans->Plans sub-menu.
  2. Click on the New button which appears on the toolbar at upper left corner.

Toolbar on Grid screen of Plan.

  1. Now, plan edit screen will appear like below. Here, you need to fill the necessary details.

    > Plan Edit Screen

On Plan Edit Screen configuration is divided in 3 sections-

Details :

  • Title : Enter the Plan Title.

  • Published : Decide whether to publish it or not. Set Yes, to publish it and No, to unpublish.

  • Visible : Decide whether to visible it or not. Set Yes, to visible it and No, to unpublish.

  • Teaser Text : This text will visible at Plan Subscription Screen.

  • CSS Classes : CSS Class to apply additional style on the plan.

  • Redirect URL : You can give the URL of the web-page where you want redirect the user after user subscribes plan. Url must be in non-sef format but right now it won't support alias of url.Eg - "index.php?option=com_community&view=frontpage" to redirect user to Jomsocial page after subscription get completes. This will redirect after Invoice Thanks page occurs.

Default time for redirection to provided Url is 3 seconds. You can change time limit using Template Overriding as per your requirement. Override this file in your template : root/components/com_payplans/templates/default/invoice/default_complete.php and change value from 3000 (It's millisecond) to your desired time in this line --] setTimeout("payplans.url.redirect('')", 3000);

  • Description: You can add detailed Plan description.

  • Time and Price :
    Expiration Type: Set expiration type to as per your requirement ie Fixed, Forever or recurring. For more detail refer the How to choose a Plan Documentation.
    Regular Price : If it's paid plan then put amount in Regular price else place it to "0" amount.

  • Association :
    Select Application for this Plan: You can select multiple applications for single plan. If you want to apply/show particular app to those who subscribe this plan,then select this app under this section. This will contain all the apps which are not a core app. Example:-If you want user can also do payment through offline payment if he/she subscribe this plan.

Core Applications Attached with this Plan: This field shows the apps which are by default attached with this plan. And these apps will come into action as soon as a customer subscribes this plan. This contain list of all apps which have created as core app. This field are not editable.

Groups (optional): Attach to a group if you want to put plan under certain group.

Plan Association

After filling all the necessary plan configuration Save the plan details.

Related KB's :

Create Hidden Plan

To Create hidden plan which is not visible to user(s) in front-end but can be assigned by admin from back-end
Follow all the above steps with one change in two parameters on Plan edit screen. Set Published and Visible to "NO" and Save the plan details

P.S:- If Visible is set to "Yes", then user cannot see the plan in front-end but can subscribe the invisible plan through URL and can also upgrade to it

To apply hidden plan to multiple users, go to PayPlans ->User sub-menu -> Select users and click on Apply Plan button on toolbar. After that choose the any plan(hidden plan will also be visible here) to apply it for multiple users in single click.

Plan and App Association

On plan edit screen in 'Association' section, below are some parameters-
Select Application for this Plan: You can select multiple applications for single plan. If you want to apply/show particular app to those who subscribe this plan,then select this app under this section. This will contain all the apps which are not a core app. Example:-If you want user can also do payment through offline payment if he/she subscribe this plan.

Core Applications Attached with this Plan: This field shows the apps which are by default attached with this plan. And these apps will come into action as soon as a customer subscribes this plan. This contain list of all apps which have created as core app. This field are not editable.

Groups (optional): Attach to a group if you want to put plan under certain group.

Plan Associaion

Plan relationship

Plan relationship / Plan dependency section
This section helps admin to set parent-child relationship between plans.
For example, if admin want to allow to subscribe a plan only when user subscribe to particular plan, then admin can do this under this section.
Plan depends on: The plan(s) you enlist here will decide the visibility of the current plan.
Make available when user is subscribed to: This field contain 3 radio buttons

  • Any of the above:- Which means that if user subscribes to any one of the plan mentioned in the “Plan depend on” text-box, then only this plan will be visible

  • All of the above:- This plan will only be visible when all the plan mentioned in the “Plan depend on” are subscribed by the user.

  • None of the above:- Display current plan when none of the plan mentioned in Plan depend” are subscribed by the user.

Plan relationship

Types of Plan

How to choose any Plan ?

Expiration Type:- Mention the type of plan. It can be one of the following
Forever Membership / Plan:-- It is a Non Recurring Plan that will be available for lifetime. Expiration time field will not be visible in this case. - In this Non-Recurring Memberships user don't have any expiration date, i.e. giving a lifetime membership. - Renewal app won't work for this type of plan i.e. this type of plan cannot be renewed.
- Mostly used when admin wants to provide Free Membership for lifetime to their users
Fixed Membership Plan / Non Recurring Plan / One time payment Plan:-

  1. Known as Non-Recurring / One-Time-Payment Membership Plan which require user to only pay one time before granting a 'Membership' .
  2. Non-Recurring Memberships can be given a date when they should expire, and when the Membership expires, after that the role(s) associated with that Membership will get removed. Remember to set Expiration time field else it will be treated as forever plan.
  3. Advantages of Non-Recurring Memberships is that users can 'Extend' their membership when it is about to expire very easily, and they can also 'Renew' their membership after it has expired. With Pro Discount app you can set different discount amount before and after expiration.
  4. Option to send an automatic email to users when their membership is about to expire, with a link the users can click to Renew their membership. You can also send an automatic email after the membership has expired, with a link to Renew the membership.
  5. Non-Recurring memberships are the easiest for most people to understand and work with, Few of the examples of Non-Recurring Membership Plans are as follows:
  6. $29.99 for 3 Months of Membership
  7. $99.99 for 6 months of Membership
  8. Free Membership for 1 Month

Recurring time and price

Recurring Membership Plan / Auto Renewal Plan / Automatic Billing Plans:- - Recurring Membership Plans are configured to accept multiple payments from a user over the course of a Membership, rather than all at the start (like the Non-Recurring Membership Plans do). This means that the users sign up for the Membership and pay the terms of the membership over the course of the membership.

  • Recurring Memberships is also used to set them to 'Recur Until Cancelled', which will indefinitely charge the user each period until he manually cancels the Membership.Set Number of Recurrence to "0" or to a maximum of number that your payment gateway support like "9999" etc.

  • When you enroll on one of recurring payment plans, your profile gets created in selected payment gateway and amount will automatically be deducted from the payment method as per recurrence count & time set in plan, Now No more worrying about writing or mailing a check or scheduling a payment.

Note :
- If you want to cancel any of recurring subscription then it need to cancel in respective payment gateways eg If profile gets created in paypal then either admin cancel the subscription of respective users from his paypal account or user himself cancel his subscription from his /her paypal accounts.

  • If you put subscription to hold or expired or delete plan from site's backend via payplans and think that recurring payment get cancelled then its a myth. In this case paypal will regularly send payment as per scheduled frequency and recurrence count and all the amount get credit to user's wallet.

  • If you change recurring plan to fixed plan then also paypal will regularly send payment as per scheduled frequency and recurrence count and all the amount get credit to user's wallet. So don't change it directly from backend.

  • This type of plan is also commonly known as "Auto Renewal" plan or Auto Billing plans ie plan get automatically renew and user don't need to pay every time or renew manually.

  • Recurring Plans / Auto Renewal plan / Auto Billing plans can only be renew after subscription get expired. During your Active Subscription no renewal is allowed.
  • Option to send an automatic email either on last recurring cycle (after this cycle user's subscription get expired) or in every recurring cycle for any information.
  • Option to send an automatic email after the membership has expired, with a link to Renew the membership with Discount functionality.Before expiration renewal won't work
  • Recurring Plans / Auto Renewal plan / Auto Billing plans is different from Installment plans. In installment plans user will pay in full or pay in installments, Payplans won't support Installment plans.
  • Few of the examples of Recurring Membership Plans are as follows:
  • $19.99 every Month for 6 Months
  • $9.99 every Month (Recur Until Cancelled)

For example : If you want to create a recurring plan which should deduct $10 from user's account after each month for 12 months.

  1. Set Regular price to be $10.
  2. Set Expiration time to be 1 month.
  3. Set Number of recurrence to be '12'. If you want it to set for unlimited time or until user cancel it then set recurrence count to '0'.

Recurrence count

Recurring+trial 1:- - If admin wants users to pay a certain amount to get access to the Membership until the Trial Period is up, after which time the user will be charged the regular amount. - You can either set a trial / setup price or even set up a 'Free Trial' period. This is very useful in situations when user needs to trial before going for regular plan.- For trial settings, set Trial 1 price and Trial 1 Time parameter for indicating the price and duration of trial.

  1. Option to send an automatic email after the membership has expired, with a link to Renew the membership. In Renewal Recurring + 1 Trial will get converted in recurring type of plans ie the trial period won't be assigned if user renew the plan.
  2. Example of Recurring +1 Trial Membership Plans are as follows:
  3. Free for the first 15 Days, then $49.99 every Month

Setting recurrence time and price

Recurring+Trial 2:- If admin wants to give user to try out plan twice and charge it differently at the 1st trial and 2nd trial, then this plan can be used. After trials, user will be automatically charged at the set interval. The only difference in this and recurring+trial 1 is that it allows you to charge different price (necessarily not regular price) for a specified duration to the customers of the plan(s).

  1. If admin wants users to pay different certain amounts (Twice a time) to get access to the Membership until the Trial Period 1 and Trial Period 2 is up, after which time the user will be charged the regular amount. - In this also you may set either a trial / setup price either 'Paid' or 'Free Trial' period with same or different amount and time periods. - For trial settings, set Trial 1 price and Trial 1 Time parameter and Trial 2 price and Trial 2 Time parameter for indicating the price and duration of trial.
  2. Example of Recurring +1 Trial Membership Plans are as follows:
  3. $1 for the first 10 Days, then $10 for next 30 days then $ 50 for every Week for 10 months
  4. Free for first 7 Days, then $5 for next 15 days then $20 for every Week for 6 weeks

Setting trial time and price

Recurring Plan Parameter

Regular Price: Enter price for the plan. Currency of the price will be specified in “Configuration” (according to the setting you have done there).

Set Expiration Time: Select time after which subscription for this Plan should expire.
If recurring, recurring +trial 1, Recurring +trial 2 plan are selected, then some additional fields will be shown like
Recurrence count:- If you want to set that user should pay forever this amount then you should set recurrence count to "0(zero)" or if you want that users should pay this amount specific number of times then you should set recurrence count to that number like 2,3, 20, etc.
Others are Trial 1 Price, Trial 1 time,Trial 2 price ,Trial 2 time etc shown according the type of plan selected.

Validate Frequency:- After saving the plan when you click on this then, a popup will appear which shows all validate frequency supported by each payment gateway. If the time is not set according to payment gateway supported time or count ,then you need to change it.

Validate Frequency

General Issues and Queries on Plan page.

QUES 1 : Plan description is not visible on mobile, why?
ANS : We have intentionally made description hidden in case of device maximum width is 460px.
If you still want to show plan description on mobile screen then you need to comment out the css code in site.css file located at path : YOUR_SITE_ROOT/components/com_payplans/templates/default/_media/css/site.css.
Current code is-

@media (max-width: 480px) {
    .payplans .pp-plan.pp-vertical .pp-plan-basic 
    {
        min-width: 100%;
    }

    .payplans .pp-plan-description
    {
        display:none;
    }
}

Replace with below code-
```
@media (max-width: 480px) {
.payplans .pp-plan.pp-vertical .pp-plan-basic
{
min-width: 100%;
}

/* .payplans .pp-plan-description
{
display:none;
}
*/
}```

Subscribe Multiple plans but extend same expiration date ?

  • In PayPlans each plan or subscription are independent and doesn't depend on have any relationship with other plan.
    So if you have created 4 different plans and want to start plan 2 when plan 1 get expired ??
    Plan 1 - 1 months
    Plan 2 - 2 months
    Plan 3 - 3 months
    Plan 4 - 6 months

As all plans are separate and it won't be possible to start plan 2 when previous plan 1 gets expired.
As these are separate plans and doesn't have any dependency among this, so expiration also comes in different way.
Plan 2 will get started as user subscribe it.

  • Alternate option is two create these plans as Recurring plan in which you can set different time period with different rate.
    Problem is that it only support till Recurring + 2 Trial not after that. With fixed plan it won't possible.

Assign Plan X when Plan Y get expired ?

PayPlans work on Subscription Active event ie any action can be taken when Plan X will get active.
In this as plan's subscription get active we can apply some action.

PayPlans won't work in case when Plan X get expired.
Eg :- You want as Paid Plan will get expired, Free plan will get assigned. So here an action is required when Plan get expired, which PayPlans won't support.
Option 1 :- Assign default plan on sign up using "Default Plan App".
http://www.readybytes.net/payplans/apps.html#/app/pp-defaultplan

Option 2 :- Assign any plan when Plan X will get active using "Assign Plan" App.
http://www.readybytes.net/payplans/apps.html#/app/pp-assignplan