====== Subscriptions ====== ~~TOC~~ \\ Subscriptions are useful for merchants who are required to perform regular and recurring payments. This feature allows merchants to set up automatic payments for a set date, regular intervals, for a specific period of time, without manual intervention, or even manual payments plans, if needed. The subscription feature is formed by two main elements: * **Stored subscriptions**: the stored subscription is a payment plan/ schedule, which works as a model for to created new subscriptions. * **Subscriptions**: the subscriptions define a plan for payments (automatic or manually trigged) for a specific customer. The **Subscription** and **Stored Subscription** features are located under the "**Customers**" tab in the **%SelfCare** system. %subscription_page \\ Also: * Every subscription will have a payment plan or schedule of some kind. This will determine how often payment is taken and how much is taken each time. * The **Subscription** feature requires the use of **Secure Tokens**, so remember to register Secure Tokens before trying to register a subscription. * To register an actual subscription, a **Stored Subscription** is necessary. \\ ===== Stored Subscriptions Registration ===== In order to be able to set up a subscription, it is necessary to set up a **Secure Token** and a **Stored Subscription** first. %stored_subscription \\ You can search for stored subscriptions by Merchant Reference number. Before you will be able to **create a new subscription**, you need to save a subscription template in the Stored Subscriptions section: * Go to the "**Create Stored Subscription**" tab and fill in the details of your subscription template. * You need to think of a **Name** for the subscription and the **Merchant Reference**. * "Merchant Ref" is a unique number which differentiates this subscription template from others. * "Name" is an extended merchant ref - the name of the subscription template. * Give a short **description** of the new subscription. * "Description" is additional information; description of the stored subscription. * Choose the **Type** of the subscription template (Manual or Automatic - without amounts). * Choose the **period type** (limited or unlimited). * Choose the **period count**. * Define **recurring price** (please note that it cannot be "0"). * Define **setup price** (it's a one-off fee which applies on the subscription start date, but you may choose not to set it up. You may leave this space blank if there is no set up price). * Choose **on update** - this option enables you to choose what will happen with the subscriptions linked to this stored template, should you decide to **amend/update** the stored subscription (template) in the future. If you wish to continue with the active subscriptions as they are, not affected by the changes made to the stored subscription, select: "**Continue subscriptions**". If you would like the active subscriptions to be updated automatically with any changes made to the stored subscription in the future, then select: "Update subscriptions". * Choose **on delete** - this option enables you to choose what will happen with the subscriptions linked to this stored template, should you decide to **delete** the stored subscription (template) in the future. If you wish to continue with the active subscriptions as they are, not affected by the changes made to the stored subscription, select "**Continue subscriptions**". If you would like to stop all the active subscriptions which are linked to this stored subscription if it was deleted in the future, then select "**Finish subscriptions**". Once you make sure that all the details are correct, click on the "Create" button below. Then the template will be saved in the "Stored Subscriptions" list, and you will be able to use it to set up a subscription. %stored2_subscription ===== Subscriptions Registration ===== If you would like to set up a a new subscription, go to "**Subscriptions**" in the drop down menu. All the previously registered subscriptions are listed in this section, and you can view their details. Depending on the subscription's status, you can find it by clicking on the specific status tab or to see all, click "All". %subscription_creation \\ **Status Meaning** * __Active__ - Subscription is still active and customer will be charged on next Payment Date. * __Suspended__ - Subscription is suspended for the moment and no charges will be taken from the customer. * __Completed__ - The subscription has been completed or the merchant has put it to completed early. The customer will not be charged and this subscription can still be searched by Merchant Reference. * __Deleted__ - Subscription is deleted, no charges to the customer. Can not be found by merchant Reference anymore. Can be searched in advanced filter. * __Cancelled__ - Subscription has been cancelled, no further charges to customer. Can not be searched by Merchant Reference. Can be searched in advanced filter. In order to be able to create a new subscription, you need select the option "Create Subscription". %subscription2_creation \\ After that, fill in the details and make sure that you complete all the mandatory fields: * Merchant Ref - You need to name your subscription with a unique reference * Stored Subscription - Choose the Stored Subscription which defines the subscription's behavior * Secure Token - Choose a valid Secure Token to charge the subscription * Notification Language - To be used when send the receipt notifications for the customer * Start Date and End Date - Limits to process the subscription * Recurring Amount - This amount can never be of "0" when editable * Setup Price - The amount can be 0, if required. Defines the initial charge of a subscription (i.e. admin fee, one off set up fee, etc). An error message will appear if there are any incomplete details or incorrect data. Once all the details have been entered, click on the "Create Subscription" button in the bottom right corner to save the subscription details. You can view the details of your new subscription in the list of all subscriptions click on the actions column and then "View" action. ===== Subscriptions Editing ===== If you would like to edit a previously created subscription, click on the "**View**" action link in the actions column. You will be presented with the edit page of that subscription. A few of the fields won't be editable: * In the **Customer Data** details tab you will be able to change the Secure Token, Notification Language and Recurring Amount. %subscription_edit_image \\ * In the **Subscription Info** details tab you will be able to set a Period Limit (if not set before), Set a quantity of periods to be skipped, change the subscription's period limits and its status.
You can reactivate suspended subscriptions, suspend active ones, complete them or even cancel/ delete).
%subscription2_edit_image \\ \\ Once you make sure that all the amended details are correct, and that you wish to save the new subscription with the changes, click on the "**Save**" button in the bottom right corner. ===== Subscriptions Deleting ===== If you would like to delete a previously saved subscription, just click on the "Delete" link in the actions column ("**...**"). %subscription_edit_image ===== Subscriptions Exporting ===== If you would like to export the details of your subscriptions, just click on the "Export Subscription" link on the top of the search result table. %subscription5_edit_image ===== Subscriptions Payment History ===== If you would like to see the payment history of a specific subscription, just click on the "View Payment History" link in the actions column ("**...**"). %subscription_edit_image After that you will be presented with another screen where you can see payments related to that subscriptions that are still open (Open Transactions) or settled (Closed Transactions) and if you click on the actions, you will be able to void/ refund them or clicking on the Order Id, you will be able to see the transaction details. %subscription3_edit_image ===== Subscriptions With Enhanced Data ===== Enhanced Data is a new feature which allows you to provide details on a payment to achieve lower fees for your transactions. To add enhanced data to your subscription payments, you use enhanced data templates (check [[selfcare:settings:enhanced_data_templates|Enhanced Data Templates]]) or add the data which should be used for details on payment in the subscription itself... __During registration__ %subscription7_new_enhancedData __After registration, clicking on the subscription (or on "VIEW" action "..." option).__ %subscription7_edit_enhancedData