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

# Working with Products

* Ensure that you have pre-defined required objects for the Product such as Billing Plan, Rate Plan (if required), or Token support.

1. Select your starting point from the following options:

   * To create a new product, click the **+ New** button and select **Product**.
   * To duplicate an existing product, select the relevant existing product from **Catalog** > **Products** and click **Duplicate**.
   * To edit an existing product, select the relevant existing product from **Catalog** > **Products** and click **Edit**.
     The Product page appears.

   <img src="https://mintcdn.com/amdocs-slm/2vaIUApFYBZeRdVJ/portal/vindiciaSubscribeAndNewRetain/Subscribe_Portal2_User_Guide/images/productNewExample.PNG?fit=max&auto=format&n=2vaIUApFYBZeRdVJ&q=85&s=7c5e462737e3af35206eac1e179cff74" alt="Subscribe Product Screen Example" width="817" height="1013" data-path="portal/vindiciaSubscribeAndNewRetain/Subscribe_Portal2_User_Guide/images/productNewExample.PNG" />

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

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

   You can return and continue editing the saved Product at any time.

   **Note:** You can edit the products at any time. It is important to understand that any changes will impact all subscriptions (existing and new) of the product.

4. When the product has been saved and completed, activate it by clicking **Activate** in the **Actions** panel.

5. Disable the product at any time, by clicking **Disable** in the **Actions** panel. Note that the product will no longer be offered to new customers (or appear in the catalog). However, existing subscriptions of the product will continue uninterrupted.

* **[Product Details Pane](../topics/productWorking1#)**

* **[Product Description Pane](../topics/productWorking1#)**

* **[Product Pricing Pane](../topics/productWorking1#)**\
  Use this pane to view/add currency/token **Standard** fixed rate Prices or a usage-based **Rate Plan** as your pricing mechanism.

* **[Product Entitlements Pane](../topics/productWorking1#)**\
  Entitlements are IDs identifying the purchased product and providing access to it. Use IDs from your system that provide subscribers access to the relevant products or services.

* **[Bundled Products Pane](../topics/productWorking1#)**\
  This pane lets you define an aggregated product as a bundle offering of separately available products. It allows you to set a bundle price that may be different than the sum price of the separate products and to provide entitlements to several separate products as a bundle.

* **[Product Token Grants Pane](../topics/productWorking1#)**\
  Tokens are a virtual currency such as a loyalty rewards, flyer miles, or stars. Use this pane to give your customers tokens when they purchase the product. If the product is used in a subscription, these tokens will be granted at each renewal of the subscription cycle.

* **[Custom Data](../topics/productWorking1#)**\
  Custom data lets you store merchant-specific data to Products, Rate Plans, Billing Plans, Season Sets, 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:**[Products](../topics/productAbout)

## Product Details Pane

| Field | Guidance | Relevancy |
| - | - | - |
| **ID** | A unique merchant-defined ID assigned to the Product. This value is often the product SKU (Stock-Keeping Unit). **Note:** use of the forward slash character (/) in merchant identifiers is not allowed. | Required |
| **Billing Statement ID** | A merchant-specified, payment processor-specific identifier that is sent with Transactions generated using this Product. The payment provider uses this value to determine the text displayed on the customer's credit card statement associated with the transaction. Enter a value for the **Billing Statement ID** *only* if you and your payment provider have agreed upon one. If you and your payment provider do not establish an ID, **leave this field blank**. Do not change this value after you first assign it unless you do so at the request of your payment processor. **Note:** Merchants who use the following payment processors may use this field for specific information: - Amazon - Compass - GlobalCollect - MeS - Orbital - PayU - WorldPay - Chase Paymentech - FDMS Payeezy - Stripe For more information, see [Custom Billing Statement Identifier Requirements](https://docs.vindicia.com/bundle/subscribeImplementationGuide/page/topics/ProgGuide_AppDataReq.html) in the Subscribe Feature Implementation Guide. | Optional, leave blank if not required by your payment provider |
| **Default Billing Plan** | Recommend the subscription frequency for this product by selecting a billing plan. This is just a recommendation and may not necessarily be the Billing Plan associated as part of a subscription. If you do not want to specify a default plan, leave this menu set to **Select a Plan** | Optional |
| **Status** | Toggle to define the status of the product. Toggle right for **Active** or left for **Inactive**. By default, set to Active. When set to active the Product offer is available for your online store. | Required |
| **End Date** | Specify the date to remove the Product offer from your online store. | Optional |
| **Created On** | A field created automatically once the product is saved. This is the initial date on which the product was created. | Automatic |
| **Tax Classification** | Subscribe leverages its supported tax vendors (currently Avalara AvaTax and and Vertex O Series) to calculate applicable taxes according to the tax classification value entered, your merchant nexus (may refer to your location, the type of business and product you sell, the regions in which you sell), and any unique tax rules configured by Vindicia for your business.​ ​​​In this field, enter the text string provided by your tax vendor for this product (based on the type of product such as physical goods, software, or electronic data). Your Vindicia implementation resource can assist you with identifying the proper value. **Note:** To access tax codes used by the Avalara AvaTax system, see [https://taxcode.avatax.avalara.com](https://taxcode.avatax.avalara.com/). For more details, refer to [Avalara Avatax System Tax Codes](https://docs.vindicia.com/bundle/howTo/page/topics/r_avalaraAvataxTaxCodes.html). | Required for regions where tax is not inclusive. |
| **Parent topic:**[Working with Products](../topics/productWorking1#) | | |

## Product Description Pane

| Field | Guidance | Relevancy |
| - | - | - |
| **Description** | Use this pane to add a brief description of the product and the language in which you want to present it to your customers. The information in this field may be used in Subscribe-generated email notifications and billing statements. Click **Add** and enter the description and its relevant language. Perform again to provide a description in another language. Click the **X** to delete a description. | Optional |
| **Parent topic:**[Working with Products](../topics/productWorking1#) | | |

## Product Pricing Pane

Use this pane to view/add currency/token **Standard** fixed rate Prices or a usage-based **Rate Plan** as your pricing mechanism.

| Field | Guidance | Relevancy |
| - | - | - |
| **Model** | Toggle to define the Pricing Mechanism. Toggle right for currency/token **Standard** Pricing or left for usage-based **Rate Plan**. By default, field is set to Standard Pricing. | Optional |
| **Standard Currency Pricing** | Multiple Currencies can be defined for Standard Pricing. Only one can be used for the customer's full payment.1. Click **Select Currency**. The Manage Currencies dialog appears. 2. Place your cursor in the selection box and select a currency using its ISO three-lettered currency code. For example, enter USD for US dollars. You can add multiple currencies for the product. 3. Click **Submit**. 4. Enter a numerical price for each of the currencies added. For example, \$9.99 (USD). 5. To remove a defined currency, click **Manage Currencies** and then click the **X** for the relevant currency. 6. Click **Submit**. | Required for Standard currency pricing |
| **Standard Token Pricing** | Token are an alternative form of payment such as flyer miles, rewards, or stars. Both tokens and currency types can be defined for Standard Pricing. Only one can be used for the customer's full payment.1. Click **Select Token**. The Manage Tokens dialog appears. 2. Place your cursor in the selection box and select the relevant token that you prepared in advance. 3. Click **Submit**. 4. Enter a numerical rate for price in tokens. For example, 1500.00 miles 5. To remove a defined token, click **Manage Tokens** and then click the **X** for the relevant token. 6. Click **Submit**. | Required for Standard token pricing |
| **Rate Plan** | Rate plans are usage-based Pricing structures. A rate plan must be prepared in advance and selected within the product's Pricing pane. 1. From the dropdown list, select the relevant **Rate Plan**. 2. Click **Preview** to view the Rate Plan's details 3. Click **X** to remove. | Required for Rate Plan pricing |
| **Parent topic:**[Working with Products](../topics/productWorking1#) | | |

## Product Entitlements Pane

Entitlements are IDs identifying the purchased product and providing access to it. Use IDs from your system that provide subscribers access to the relevant products or services.

| Field | Guidance | Relevancy |
| - | - | - |
| **Select** | 1. Place your cursor in the selection box and select from pre-defined Entitlements. 2. You can select multiple Entitlements per product. 3. Click **X** to remove. | Optional |
| **Create New** | 1. Create a new Entitlement by entering an ID and a description in the corresponding fields. 2. Click **Create**. The newly defined Entitlement is added to the **Select** Entitlement list. | Optional |
| **Parent topic:**[Working with Products](../topics/productWorking1#) | | |

## Bundled Products Pane

This pane lets you define an aggregated product as a bundle offering of separately available products. It allows you to set a bundle price that may be different than the sum price of the separate products and to provide entitlements to several separate products as a bundle.

| Field | Guidance | Relevancy |
| - | - | - |
| **Select** | 1. Place your cursor in the selection box and select from the list of existing Products. 2. Select at least two Products. A list of the relevant entitlements for the selected products appears. 3. Click **X** to remove a product from the list. **Note:** If the product is a bundle product, do not use the Entitlements pane to provide entitlements. | Optional |
| **Parent topic:**[Working with Products](../topics/productWorking1#) | | |

## Product Token Grants Pane

Tokens are a virtual currency such as a loyalty rewards, flyer miles, or stars. Use this pane to give your customers tokens when they purchase the product. If the product is used in a subscription, these tokens will be granted at each renewal of the subscription cycle.

| Field | Guidance | Relevancy |
| - | - | - |
| **Add** | To grant tokens when the product is purchased, click **Add**. Select an existing token type from the dropdown list, and enter the amount granted in the **Value** field. You can define multiple types of Tokens per product.To remove a selected token, click the **X** for its line. | Optional |
| **Parent topic:**[Working with Products](../topics/productWorking1#) | | |

## Custom Data

Custom data lets you store merchant-specific data to Products, Rate Plans, Billing Plans, Season Sets, 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 Products](../topics/productWorking1#) | | |


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