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

# Working with Rate Plans

Rate Plans can be created as new, duplicated from existing rate plans and edited. Existing rate plans can be edited in the Portal prior to activation. Once activated and in use for Subscriptions, changes to Rate Plans can only be enforced via API.

For quantity-based subscriptions, ensure you retrieve the product identifier (**PLM-CODE**) from Partner Ecosystem Management and add it in the **Custom Rate Plan Data** section.

**Note:** In most cases, you'll create a separate Rate Plan for each Product. However, you can reuse a Rate Plan across multiple Products if needed.

1. Select your starting point from the following options:

   * To create a new rate plan, click the **+ New** button and select **Rate Plan**.
   * To duplicate an existing rate plan, select the relevant existing rate plan from `Catalog > Rate Plans` and click **Duplicate**.
   * To edit an existing rate plan select the relevant existing rate plan from `Catalog > Rate Plans` and click **Edit**.
     The Rate Plan page appears.

2. Define the Rate Plan fields as needed. Refer to the tables below for guidance regarding the fields.

3. For quantity-based subscriptions, add **PLM-CODE** to the **Name** field and the corresponding product identifier to the **Value** field in the **Custom Rate Plan Data** section.

4. When you're done, click **Save** or **Update**.

   You can return and continue editing the saved Rate plan if it has not been activated yet.

5. If saved as inactive, click **Activate** in the **Actions** panel.

6. To stop the rate plan, click **Disable** in the **Actions** panel. A confirmation message appears.

   **Note:** Rate plans that are in use can't be disabled and a relevant error message will appear.

* **[Rate Plan Details Pane](ratePlanWorking#rate-plan-details-pane)**\
  Rate Plans are pricing structures that let you price your offering according to consumption or tiers.
* **[Rate Plan Minimum and Maximum Fees Pane](ratePlanWorking#rate-plan-minimum-and-maximum-fees-pane)**\
  The **Minimum** and/or **Maximum** charge levied, per Billing Cycle. Your customer will not be charged less than the minimum fee, or more than the maximum fee, for any given Billing Cycle, regardless of their access level. A minimum fee is required.
* **[Rate Plan Rate Tiers Pane](ratePlanWorking#rate-plan-rate-tiers-pane)**\
  Tiers define one price for the first number of a given Product, and a different price for subsequent blocks of the same Product.
* **[Custom Data](ratePlanWorking#custom-data)**\
  Custom data lets you store Reseller (Service Provider)-specific data to Products, Rate Plans, Billing Plans, Subscriptions, Accounts, and Payment Methods as a pair of matched text strings, called name-value pairs. These name-value pairs can help you categorize and sort aspects of your objects. Use **Name** to define a category, and **Value** to define a specific item in that category. For example, you could use name-value pairs to track your sales teams. Define a name-value pair with Office as the **Name** and the city in which the office is located as the **Value**.

**Parent topic:**[Rate Plans](ratePlanAbout)

## Rate Plan Details Pane

Rate Plans are pricing structures that let you price your offering according to consumption or tiers.

| Field | Guidance | Relevancy |
| - | - | - |
| **Status** | Once Saved, the top bar of the page displays the rate plan status such as Active or Inactive. | Automatic |
| **ID** | Your unique ID for the rate plan. The ID can't be changed or reused. **Note:** use of the forward slash character (/) in Reseller (Service Provider) identifiers is not allowed. | Required |
| **Description** | A meaningful and unique description of the rate plan. | Optional |
| **Units** | From the dropdown menu, select an existing unit or create a new unit. When creating a new unit define its name in both singular and plural forms. These names the appear in the customer Billing Statements. | Required |
| **Included Units** | Number of units included in the base subscription before rated billing begins. Enter a digit. Default value is 0. | Optional |
| **Decimal Places** | Select the number of decimal places to which Commerce Engine will round reported Rated Unit Event totals. This number affects the value displayed for the Begins at Level, as well as the manner in which Commerce Engine will calculate Billing Cycle charges for Rate Plan priced Products. Default level is 0.For example, given a total of 346.26961. - 0 rounds to the nearest integer (346) - 2 rounds to the nearest hundredth. (346.27) **Note:** License quantity does not use a decimal place and would be a whole number. | Optional |
| **Status** | Toggle between **Active**/**Inactive**. Inactivate the plan when you no longer want to offer it to your customers. Default value is Active. | Required |
| **Model** | Default value is **License**. The usage is calculated in advance based on the number of units purchased or licensed. | Required |
| **Charge** | The value **Per Unit** is available. | Required |
| **Price On** | Select the method by which the Rate Plan prices per Billing Cycle.- **Each respective Tier**: for each respective Tier, multiplies the number of Rated Unit Events for the Billing Cycle by the Rate Price for the Tier in which they occurred; and calculates, for each respective Tier, the charge by Tier use. That is, if a Tiered Plan is defined as $2 for 0-9 units, and $1 for 10-100 units, a customer who uses 15 units will be charged $2\*9 + $1\*6 = $24. - **Highest Applicable Tier**: to the highest applicable Tier, multiplies the total number of Rated Unit Events for the Billing Cycle by the price for the Tier in which the total number occurs. That is if the same plan as above was used, and 15 units again were used the **Highest Applicable Tier** would calculate the charge by multiplying 15 units by $1.00, for a total charge of \$15. | Required |
| **Parent topic:**[Working with Rate Plans](ratePlanWorking) | | |

## Rate Plan Minimum and Maximum Fees Pane

The **Minimum** and/or **Maximum** charge levied, per Billing Cycle. Your customer will not be charged less than the minimum fee, or more than the maximum fee, for any given Billing Cycle, regardless of their access level. A minimum fee is required.

| Field | Guidance | Relevancy |
| - | - | - |
| **Manage Currencies** | To start using the pane, you must first define the relevant currencies for the rate plan. Note that these currencies must also be aligned with the Billing Plan and Product when creating a subscription. 1. Click ​**Manage Currencies​** ​in the **​Actions**​ panel.​​ 2. Place your cursor in the box and select the relevant currencies.​ 3. Click **Submit**. Minimum and Maximum fields appear for each of the defined currencies. ​ | Optional |
| **Minimum** | The minimum fee that the customer will be charged for the rate plan. | Required |
| **Maximum** | The maximum fee that the customer will be charged for the rate plan. | Optional |
| **Parent topic:**[Working with Rate Plans](ratePlanWorking) | | |

## Rate Plan Rate Tiers Pane

Tiers define one price for the first number of a given Product, and a different price for subsequent blocks of the same Product.

| Field | Guidance | Relevancy |
| - | - | - |
| **Tier Name** | Name of the Tier. Defaults to Tier 1, Tier 2, and so on. | Required |
| **Starts at Unit** | The first number of Units for which the price for this Tier in the Rate Plan will be applied. You define the starting unit for each tier after the first. The first will start at 1 or the equivalent, depending on the number of decimal places. For example, if you choose 3 decimal places the first tier will start at 0.001. | Required |
| **Ends at Unit** | Ends at units are calculated based on the Starts at unit of the next tier. The last tier is infinity. This is also based on the number of decimal places. For example, if you select 3 decimal places and start the second tier at 5.001, the previous tier will end at 5.000. | Optional |
| **Rate Price** | For each currency, specify a price to be applied for units rated in this tier. (Note that depending on Price On choices, all usage will be priced at this rate for just the usage that falls in this tier.) | Optional |

**Parent topic:**[Working with Rate Plans](ratePlanWorking)

## Custom Data

Custom data lets you store Reseller (Service Provider)-specific data to Products, Rate Plans, Billing Plans, Subscriptions, Accounts, and Payment Methods as a pair of matched text strings, called name-value pairs. These name-value pairs can help you categorize and sort aspects of your objects. Use **Name** to define a category, and **Value** to define a specific item in that category. For example, you could use name-value pairs to track your sales teams. Define a name-value pair with Office as the **Name** and the city in which the office is located as the **Value**.

| Field | Guidance | Relevancy |
| - | - | - |
| **Name** | Name is the field for defining metadata. It is unique and once submitted can't be changed. 1. Place your cursor in the selection box and either select from existing Names or enter a new Name. 2. For a new entry, click **Create New:** 3. Enter a Value for the Name. 4. Click **Add** to save this pair. **Note:** - Name field is limited to 255 characters. - System generated parameters use the prefix **vin** in the name field. | Required if adding custom data |
| **Value** | 1. Once you've selected/created a Name. 2. Enter the category's Value in the corresponding field. 3. Click **Add** to save this pair. **Note:** Value field is limited to 255 characters. | Required if adding custom data |
| **Parent topic:**[Working with Rate Plans](ratePlanWorking) | | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.