SubscriptionBridge: recurring billing and subscription management system - Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Adding and Editing Plans ======

===== What a Plan is =====

A plan defines the billing arrangement (see the [[:glossary|Glossary]]). 

Plans are not product-specific. The same Plan (e.g. monthly payment, with a free 2-month trial) could well be shared across different subscription-based products and services.
===== Payment Gateways and Supported Payment Plans =====

Different payment gateways have different requirements and limitations with regard to the billing plans that they can support. For example, Authorize.Net does not support a billing period that is shorter than 7 days.

SubscriptionBridge is setup to enforce these requirements/limitations when you create a new plan, depending on which payment gateway you have selected. So if Authorize.Net is the payment gateway selected for a certain //store//, and the billing period is "days", then the number of days that can be selected will start at 7. 

Authorize.Net also requires that the standard billing and trial billing periods share the same billing unit (days vs. months) and frequency. Therefore - if Authorize.Net is the selected payment gateway - only the total number of trial occurrences can be set. 

===== Adding a New Plan =====

To add a new Plan, do the following:

  * Click on //Stores// in the Merchant Center navigation
  * Select any of your //Stores//
  * Under //Packages//, select //Plans//
  * The page will display a list of available Plans. Click on //Add New Plan// to add a new one.

{{:merchant_guide:screenshot149.jpg|A list of available Plans in a SubscriptionBridge Merchant Center}}

On the //Add New Plan// form you will find the following fields:

  * **Reference Name** \\ This is an internal name for the //Plan//. It is not shown to customers.	
  * **Billing Period** \\ Select the billing interval from the following selections: __day__, __week__, __month__, __year__. You can use the //Billing Frequency// field to "adjust" the //Billing Period//. __For example__, to create a //Quarterly Billing Period//, choose //Month// here and then enter 3 under //Billing Frequency//.
  * **Billing Frequency** \\ Select how often the subscription will be billed, based on the interval selected under //Billing Period//. __For example__, if you are selling a bi-weekly subscription, you will select "Week" under the Billing Period and enter 2 under "Billing Frequency" (the subscription will be charged every 2 weeks). Note that some payment gateways have restrictions on the frequency. For example, [[payment-gateways:authorize.net|Authorize.Net]] requires that the billing interval be between 7 and 365 day (i.e. you can't have a subscription shorter than a weekly subscription, if you are using Authorize.Net).
  * **Total Billing Cycles** (//Bill until canceled?//) \\ Enter the total number of billing cycles. For an ongoing subscription (a subscription that never ends), answer "//Yes//" to the question "//Bill until canceled?//", or enter //0// if there is an input field. If the subscription does end after a certain number of billing occurrences, then enter that number here. __For example__, if you wanted to sell a 2-year subscription that is billed quarterly, you would enter:
    * Month under Billing Period
    * 3 under Billing Frequency
    * 8 under Total Billing Cycles (4 quarters a year, times 2 years).
  * **Currency Code** \\ Select the currency used by your store. 	
  * **Is there a Trial period?** \\ Indicate whether there is a //Trial// period or not. Note that a //Trial// does not have to be a "Free Trial". In fact, the trial amount could be higher than the regular subscription amount (e.g. it may include an initial setup fee). You will specify the trial amount at the //Package// level.
  * **Trial Billing Period** \\ Select the billing interval (e.g. "Month") for the Trial period. __NOTE__: with **Authorize.Net**, this is not supported: by default the Trial Billing Period is the same as the Billing Period.
  * **Trial Billing Frequency** \\ Select how often the subscription will be billed during the trial, based on the interval selected under //Trial Billing Period//. __For example__, if you want to offer a 3-month trial at a discounted price, you will select "Month" under the //Trial Billing Period//, enter 1 under "Trial Billing Frequency", and enter 3 under //Trial Total Billing Cycles//. __NOTE__: with **Authorize.Net**, this is not supported: by default the Trial Billing Frequency is the same as the Billing Frequency.
  * **Trial Total Billing Cycles** \\ Enter the total number of billing cycles for the //Trial Period//. For a free 1-month trial, you would enter 1 here, 1 under //Trial Billing Frequency//, and "Month" under //Trial Billing Period//. __NOTE__: with **Authorize.Net** the Trial Billing Cycles ("Trial Occurrences" in the Authorize.Net documentation) are counted as part of the Total Billing Cycles ("Total Occurrences" in the Authorize.Net documentation).
  * **Subscription Starts Immediately?** \\ In most cases, you will answer "Yes" as the subscription will start at the time it is ordered. If there is a //Trial Period//, the subscription will start with the trial. Otherwise, if the subscription is set to start in the future (e.g. the first of January of the following year) select a //Start Date// in the corresponding field.
  * **Start Date** \\ Enter a //Start Date// if the subscription is not set to start immediately (i.e. at the time it is ordered). If there is a //Trial Period//, the //Trial// will start on the //Start Date//.

{{:merchant_guide:screenshot150.jpg|The Add New Plan page}}

===== Viewing and Editing Existing Plan =====

To view all the Plans in your SubscriptionBridge Merchant Center, do the following:

  * Click on //Stores// in the Merchant Center navigation
  * Under any of the stores, locate the //Packages// section and mouse over //Plans//. The system will display a preview of the plans you added. Click on the link to load the list of Plans.

On the page that lists all //Plans// under the selected //Store// you can:

  * Click on any column heading to sort the table by that column
  * Click on the //Edit// icon ({{:merchant_guide:edit.gif|Edit Icon}}) to edit the //Plan//'s properties
  * Click on //Packages// to view and edit existing //Packages// that use that //Plan//

<note important>If you edit a //Plan//'s properties (e.g. you decide to edit the billing cycle), this will affect new subscriptions that are created in the SubscriptionBridge system for any of the Packages that use that Plan, but it will __not__ affect existing subscriptions.</note>

===== Deleting Plans =====

Plans that are not currently used within a //Package// can be deleted. To delete a Plan:

  * Click on //Stores// in the Merchant Center navigation
  * Select the //Store// that you wish to work with
  * In the //Packages// section, mouse over //Plans//. The system will display a preview of the Plans that you added to that store. Click on the link to load the list of //Plans//.
  * Check the checkbox in the right-side column of the plan(s) you wish to remove, and click on the //Delete Selected Records// button to remove the selected Plans. Please note the following:
    * Plans can only be deleted when not used in a //Package//.
    * When a Plan is used in a //Package//, the checkbox is not shown.
    * When no Plans can be deleted, the //Delete Selected Records// button is not shown on the page.

===== Related Articles =====

  * [[products|Adding and Editing Products]]
  * [[packages|Adding and Editing Packages]]
  * [[packages|Adding and Editing Features]]