What are Add-Ons and how to configure them

Limio Add-Ons modify an existing subscription by either introducing an additional product or providing a perpetual discount. Add-ons are added onto an existing subscription product, so it does not have a Term or Auto-Renew (those are defined by the existing subscription). 

If you need to create a standalone subscription, consider using Offers. Learn more at What are Offers and how to configure them?

Creating Add-Ons in Limio

The process of creating a subscription add-on is similar to the core Limio Offer concept. Go to 'Add-ons' from the left hand navigation and fill in the necessary information.

Out of the box, these are the fields available for configuration:

Field	Description	Required?
Name	The add-on name. This is only visible in the Limio app	Yes
Add-on display name	The add-on name that will be visible to the end user	Yes
Label	The label used to include add-ons to a page
Description	The description the end user will see
Price	The price for this add-on. This can be defined in Limio or it can be pulled externally.
Add-on type	You can define types for add-ons for easy categorisation
Rate plan	The corresponding Zuora rate plan for this add-on	Yes

You can create an add-on template in order to customise the view based on your specific needs, for example, you can hide certain fields.

Integration with Zuora

• Catalog: When products are synchronized to Limio, the Zuora products to be used for Limio Add-Ons are synced in and are then available under the 'Products' tabs on the Add-Ons.

• Order: In Zuora, an add-on will add a new product and rate plan into an existing subscription.

Checkout Process

If add-ons are selected during the acquisition journey, they will be incorporated during order processing and will appear in the Zuora subscription.

Utilising Add-Ons in SDK

After constructing and publishing a page, you can access the add-ons in the SDK using the useCampaign hook. Here's an example:

import { useCampaign } from "@limio/sdk"   
const CustomComponent = () => {  
    const { offers = [], addOns =[] } = useCampaign() 
}

Example add on object:

{
"name": "AddOn",
"record_type": "add_on",
"baseTemplate": "/config/templates/add_ons/default",
"attributes": {
    "display_name__limio": "Add On display name",
    "label__limio": [
        "any",
     ]
     },
    "user": "[e-mail]",
    "path": "/add_ons/addOnPath",
    "created": "2023-10-09T13:28:28+00:00",
    "modified": "2023-10-09T13:28:39+00:00",
    "productBundles": [
    {
        "product_path": "/product/path",
        "revenue_split": "100",
        "rate_plan": "add on rate plan"
    }
    ],
    "products": [
    "/product/path" 
    ]
}

Add-Ons in orders: 

If there is a custom implementation of an acquisition or editing a subscription page utilising add ons to enable the purchase of the add ons they can be added to the order through the available methods in the SDK (see here). It is important to be aware that add ons have quantities that must be included in the addToBasket to correctly process the order. Below is an example on how this action should be.

addToBasket(offer, {addOns: [{addOn: selectedAddOn, quantity: 1 || userSelection},...])