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

# Subscription plan

# Steps

To set up a subscription plan in UniBee admin portal, follow these steps:

## Step 1: Define Products and Plan

* Subscription plans are organized under product offerings. First ensure you have created a product before setting up plans.

## Step 2: Basic Setup

* Input Plan Name and Description
  * Enter the name of the plan in the `Plan Name` field.
  * Provide a brief description of the plan in the "Plan Description" field.
* Select the Plan Type
  * Choose from the dropdown: Main plan, Add-on, or One-time payment
* Input External Plan ID (Optional)
  * If applicable, enter the external identifier for the plan in the "External Plan ID" field.
* Choose the Currency
  * Select the currency for the subscription plan from the currency drop-down menu.
* Define the Pricing
  * Specify the price amount for the plan in the Price field.
* Define the Billing Period
  * Choose the interval unit (day, week, month, or year)
  * Enter the number of interval units
  * Examples:
    * For a monthly recurring plan: Choose `Month` as Interval Unit and input `1` as Interval Count.
    * For a semi-yearly recurring plan: Choose `Month` as Interval Unit and input `6` as Interval Count.

## Step 3: Advanced Setup (Optional)

* Configure Add-ons
  * In the "Recurring Add-ons" field, select add-ons to attach to the main plan
  * In the "One-time-payment add-on" field, choose one-time payment options
* Configure Trial Period
  * After the Trial switch is turned on, All Trial in the Summary column on the right will show "Yes"
  * Set a Trial Price (use 0 for free trials)
  * Define Trial Length by specifying duration and unit (days, weeks, etc.)
  * Choose whether to require payment information during trial with the "Requires Payment Info" option
  * Set whether subscriptions should automatically renew after trial ends
* Configure Usage-based Billing
  * Set up limit metered usage
  * Configure charge metered usage
  * Set up recurring charge metered usage
* Add Custom Data
  * Add any custom metadata in JSON format if needed for integration purposes

## Step 4: Review Summary

* The Summary panel displays all your plan configuration settings for easy review before saving.

## Step 5: Save and Activate the Plan

* Click the "Save" button to save the defined plan.
* Click the "Activate" button to activate the plan.
* Click the "Publish" button to make the plan available to customers.

By following these steps, you will successfully set up and activate a subscription plan in the UniBee billing system.
