---
title: "Create a Refer & Earn plan"
slug: "refer-and-earn"
updated: 2023-07-04T21:08:07Z
published: 2023-07-04T21:08:07Z
canonical: "docs.viewlift.com/refer-and-earn"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.viewlift.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Refer & Earn plan

Increase your chances of app downloads with referral marketing. Create a **Refer and Earn** plan page and attach the plan with your desired SVOD plan. Existing subscribers can then invite their friends by generating a referral link and sharing it via email and social channels. Upon successful referral, both the referrer and the friend referred can get a free subscription extension by the number of days that you set in both the Refer & Earn plan and the SVOD plan(s).

Note:On web, the Refer and Earn modular page currently supports sharing option only for **WhatsApp**, **Facebook**, and **Twitter**.  For your apps, you can toggle on sharing on other social platforms from the Invite channels section in your **GetSocial** dashboard.  
In the GetSocial platform, click the **User acquisition** icon in the left pane, then click the **Smart Invites** tab. In the [**Invite channels**](https://docs.getsocial.im/guides/smart-invites/channels/supported-invite-channels/) section, select the additional channels to extend your outreach.

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/get-social-enable-channels.png)Share referral links on a variety of social channels (iOS and Android apps-only)

**Prerequisites**

1. You must have a [GetSocial](https://www.getsocial.im/) account. Once you create an account, please enter the **GetSocial App ID** and the **Secret Key** in the **AppCMS**:![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/secret-key-app-id.png)Copy App id and Secret key from your GetSocial account![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/appkey-appcms-viewlift.png)Paste the App id and Secret key in ViewLift Tools (AppCMS > Settings > NOTIFICATIONS & ENGAGEMENT CHANNELS)
2. Add the [webhook](https://docs.getsocial.im/guides/exporting-data/webhooks/) on the GetSocial dashboard. The standard URL format is "**https://prod-api.viewlift.com/subscription/webhook/<yoursiteinternalname>/get-social"**  
**![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/adding-webhook.png)**

## Create a **Refer & Earn Plan** page

Create a **Refer & Earn Plan** page from the **Monetization** tab.![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/sample-refer-a-friend-plan.png)

Plan summary for Refer a Friend Annual and Monthly plans 

Create country-specific plans if you want to create referral plans for more than one country.

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/refernearn.png) **Relevant screen details for Refer & Earn page** 

| **Cost Per Billing Period** | The actual price of the subscription plan. |
| --- | --- |
| **Discounted Price** | Enter the discounted price here. Do not enter the discount percent here. If you wish to mention the discount percent, use the **Description** text box. |
| **No of Days To Be Extended** | For each successful referral, number of days a referrer will get an extension from the current billing period. Set the number of days of extension here. "No Of Days To Be Extended" must also be added in the referrer's user plan - monthly or annual. The field should not be blank. |
| **Supported Devices** | Device platforms where you want to activate the plan. |

For the complete screen details for a plan page, see the [Create an SVOD plan](https://docs.viewlift.com/docs/create-svod-plan) article.

## Create a Refer & Earn View Plans page

As the next step, create a Refer & Earn View Plans page (marketing landing page). The Referral View Plans page lets a referred user select a plan and get a discount on their first payment.

1. From the **AppCMS**, go to **Templates** > **Edit Template.**
2. To create the Referral View Plans page, in the **Template Builder** page, under **Pages**, click the **Add New** button.
3. In the **Create New Page**, provide the **Page Name**, (example: Referral View Plans), and set the **Page Type** as **Marketing** **Page**.
4. Once you've created the page, click the **Settings** menu on the **Template Builder** banner on top. The **Page Details** section is displayed on the left of the **Settings** page.
5. In the **Path** field, provide the page path. For example, **/****referral-viewplans**, **/referral-plans**, etc.  
![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/refer-marketing-page-viewlift.png)
6. From the **Template Builder** banner, click **Add Modules**, and find the **Referral Select Plans (Web)** module.
7. Drag and drop the module into the page, and click the settings icon. In the  **Referral Select Plans (Web)** property inspector, configure the required information and click the close button. See the **Screen Details below**for more information.![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/image-1634727112543.png)

**Refer & Earn** **View Plans important screen details**

| **Screen element** | **Description** |
| --- | --- |
| **Title** | Add a title such as "Welcome to ABC TV" |
| **Description** | Description of the Refer & Earn plan. Example: "You have been referred by a friend. To start streaming the world's best performances, please select a plan below and get 30% off your first payment." |
| **Plans (Separated by comma)** | Copy the GUID of the SVOD plans and paste them in this field. The GUID for a plan is the part of the URL that appear after /edit in the Monetization tab: ![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/code.png)Example plan ids: a8dd68e1-c12f-502k-9f91-1f5383a1fiii, 85406pp1-7831-4f34-b312-cf9a5hc14b89 If you want to create a referral plan for both Monthly & Annual SVOD plans, add the GUIDs of both the plans in this field, separated by a comma. |
8. Add the other modules such as the masthead, Raw HTML, and Rich Text as you'd need.  
  
![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/edit-referral-plan.png)

Click **Publish Page** to make the page go live on your site and apps.

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/Marketing-pages.png)Create separate referral plans for countries

When a friend referred by your subscriber clicks on the referral link, your refer and earn landing page should display:

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/referral-markketing-page-viewlift.png)Clicking on a plan redirects to the account creation page 

Make sure to mark the Refer & Earn plan as invisible on the plan creation page so only users with the referral link can see the plan. You cannot open the referral plan link (https://watch.abctv.com/referralplans) directly, only a referred user can see the plan page using the referral link.

A Refer & Earn URL will look like: https://www.example.tv/refer-viewplans?_gs_cid=c.67b999weee9999e9e9e9e99ee9, where _gs_cid is the Get Social ID for the plan. You can track this from your GetSocial dashboard.

The referrer can also check the status of their referred friends in the **Referrals** section on the **Accounts** page of the website and apps (if you have added the apps in the **S****upported Devices** field on the Refer&Earn plan page). The referrer can also get, for example, 1 month of free subscription on every successful referral (or any referral duration that you define in the **Number of extended days** field). If your subscriber gets two of their friends to subscribe, they can get an extension by 2 months.

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/account-settings-page-referral-viewlift.png)Check the referral status of friends on the Accounts page

## Create a Refer & Earn modular page

To generate the referral code and allow sharing on socials, set up a Refer & Earn modular page in the Template Builder. Example referal code: https://refer.example.tv/yekvTMjaZl

1. From the **AppCMS**, go to **Templates** > **Edit Template.**
2. In the **Template Builder**, under **Pages**, click the **Add New** button to create a new page.
3. In the **Create New Page**, set the **Page Name** as Refer and Earn, and the **Page Type** as **Modular Page**.
4. Once you've created the page, click the **Settings** menu on the **Template Builder** banner on top. The **Page Details** section is displayed in the left of the **Settings** page.
5. In the **Path** field, provide the page path. Example, type **/****refer** or **/****referral**.  
![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/referral-settings-page(2).png)
6. In the SEO properties, provide an **SEO Title**, **Keywords,** and a **Description** for the page. The Page style properties are automatically fetched from the default page style settings of your app/website.
7. From the **Template Builder** banner, click **Add Modules**.
8. In the **Add a New Module** form on the right, drag and drop the **Refer and Earn** module into the page, and click the **Settings** icon.
9. In the **Edit Refer and Earn (Web)** settings panel, configure the required information, and click the close button. See the **Screen Details** below for more information.

| ![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/refernearn-modular-page.png)Refer & Earn Modular Page ![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/refernearn-modular-page-multiple.png)Expand your Refer & Earn strategy: Create multiple Refer & Earn modular pages for different use cases | ![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/image-1627601050169.png) |
| --- | --- |

Click **Publish Page**.

#### **Edit Refer and Earn (Web) Screen details**

| **Screen element** | **Description** |
| --- | --- |
| **Add** | Click the **Add** button to add image objects to the referral page. The following fields are displayed: - Image URL: Use the CMS module to upload the images that you want to display here, and copy the image URL from the CMS and paste it in the Image URL field. Here's an example URL of an image, https://snagfilms-a.akamaihd.net/ec1a73f8-7e0e-40e9-9054-03f6bac6ecb1/images/2021/02/23/1614099338189_3_onemonth_iconimages-tab.png?impolicy=resize&w=172&h=169 **Note:** You can modify the width and height of the image by changing the values for "w" and "h" from the URL. Ensure to keep uniform values across the images in the same row. - Description: Provide a description of the referral plan. |
| **Share via** | - In the **Label****Text** field, provide the label text such as Whatsapp, Facebook, Twitter, Email, and so on. - In the **Image****URL** field, provide the image URL for the icon. The original values of "w" and "h" copied from the image URL in CMS can be bigger, you can modify the values as you see fit. |
| **Localization** | Specifies that localization exists for the text fields described below. |
| **Free Text Message** | Provide a description of the free referral plan. For example, "Your <app> subscription will be extended by 1 month once your friend subscribes!". |
| **SignIn Button on Referring Page** | If a user is not signed in, add a message to sign in to refer a friend. |
| **Subscribe Button on Referring Page** | Add a description for the subscribe button. |
| **Copy URL Text** | Provide a description when a user clicks on the copy URL image. For example, URL Copied! |
| **Share via** | Provide a description, for example, "Share via". |
| **Share via Email Subject (For Email)** | Provide the subject line for the email. For example, "Join me at XYZ TV and get 30% off!" When a user clicks on the Email icon, the default mail client will open and display the messaging you provide in this field. |
| **Share via Email Body** | Body of the email message. Clicking on the email icon generates a unique referral URL and is displayed in the email. ViewLift supports {Inviter} and {company} merge tags so the tags are replaced with user name and service name in the email for personalization. This info is fetched from **AppCMS** > **Service** page. Use **#LB#** to insert a line break in your message. |
| **WhatsApp Tooltip Text** | Provide a tooltip, such as, "Make sure that you have installed WhatsApp". |
| **Status of Referred friends link for this page** | Provides a clickable link to display a list of referred friends. |
| **Terms and Conditions Text** | Provide a title for the Terms and Conditions link. Example: Referral Terms and Conditions. |
| **Terms and Conditions Page URL** | Provide a URL for the Terms and Conditions page. Example: /referral-terms-and-conditions |

A modular page is to sign in to your site/apps, and then refer a friend:

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/Example-referral-page.png)Click on a Share via option to invite your friends

## FAQs - Refer and Earn

**Q.** **How do the rewards appear on the end-user's side on the platform?** Users can see a list of successful referrals they made using the **Referrals** section on their **Account Settings** page. Here's an example:

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/refernearnexample(2).png)

The billing cycle of the user that refers a plan (referrer) gets an extension by the duration that you have set for that plan in the Refer and earn plan. To see the new billing date and billing history, in the **Account Settings** page, go to **Billing & Payments** > **Billing History** > **See full history**. You must also specify the extension duration on the SVOD Plan creation page.

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/refernearnextension.png)

Verify the Refer & Earn extension in the user's account information in the [Users](https://docs.viewlift.com/docs/user) tab.

![](https://cdn.document360.io/15e0c142-c823-4c77-a8e8-9d32ca937982/Images/Documentation/billing(1).png)

**Q. D****ata capturing and extension issues.** Please raise a support ticket with us. We have taken the following resolutions in the past: Make sure the webhook URL is added to the GetSocial dashboard. This helps us to check whether the necessary referral events like subscription completed, payment confirmed, etc are getting tracked. Once the webhooks are being delivered to https://prod-api.viewlift.com/subscription/webhook/<sitename>/get-social, ViewLift starts getting callback requests to https://api.getsocial.im/v1/referral/referred? for user events such as app installed, subscription completed, payment confirmed, and other referral data.

Make sure you are saving event logs in GetSocial for at least three months so there are enough data to debug issues. For instance, we might get the callback for app_install only and not receive the callback from the subscription_completed event from GetSocial.

Also, check if the Refer & Earn engine is implemented on the backend of your country-specific payment gateways.

**Note**: Conversion attribution for GetSocial won't work on pages built outside of the Template Builder as we can't control the SDK trigger via a third-party page. Conversion and the "subscription created" events trigger correctly on GetSocial and ViewLift when a referred user hits the referral link. Example: https://hellotv.gsc.im/PqjMCT5jKU

**Q. GetSocial seems to be the platform for reporting and managing referrals so would be good to get a run-through of the reporting capabilities on the platform.** You can request a product tour with the [GetSocial team](https://www.getsocial.im/) directly.