Working with Products

Make sure that all required items for the Product (e.g., Billing Plan, Campaign, Rate Plan) are set up at the appropriate stage in the process, if applicable. These do not need to be configured before beginning, but must be completed before the Product can be used.
Review the Required Custom Data table below to understand which Custom Data fields are needed when creating a Product. Each entry in the table includes:
- Field Name: the name of the field as it appears in this application.
- Description: a brief explanation of the field’s purpose.
- Source: where to find the value (e.g., billing plan within the application or the Partner Ecosystem Management component). Note: Some values (such as BILLING-OPTION-1, the billing plan ID) may not be available at the time of product creation. If you’re creating a product shell, you can leave these fields blank and return to update them once the required data becomes available.
To apply eligibility rules, configure the relevant fields in the Custom Data section. For information about the fields, see the Eligibility Rule Fields table below.

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.
Define the Product fields as needed. Refer to the tables below for guidance regarding the fields.
Add the required custom data. Refer to the Required Custom Data table below for field names and example values.
(Optional.) To apply eligibility rules, configure the relevant fields in the Custom Data section. Refer to the Custom Data table below for guidance regarding the fields.
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.
When the product has been saved and completed, activate it by clicking Activate in the Actions panel.
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
Product Description Pane
Product Pricing Pane
Use this pane to view/add currency Standard fixed rate Prices or a license-based Rate Plan as your pricing mechanism.
Custom Data
Custom data lets you store Reseller (Service Provider)-specific data to Products 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.
Required Custom Data
In this section, select each required field from the dropdown menu and enter the appropriate value for your product configuration. These values may originate from various sources, including billing plans within the application or other product components (e.g., Partner Ecosystem Management). Refer to the table below for field names, descriptions, value sources, and example values.

Parent topic:Products

Product Details Pane

Field	Guidance	Relevancy
ID	A unique ID assigned to the Product. This value is often the product SKU (Stock-Keeping Unit). Note: Use of the forward slash character (/) in identifiers is not allowed.	Required
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. Note: There are additional steps that are required to link your billing plan with the product. Work with your Amdocs representative to complete these steps.	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	Commerce Engine leverages its supported tax vendor (currently Avalara AvaTax) to calculate applicable taxes according to the tax classification value entered, your 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 Amdocs 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 Amdocs 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.	Required for regions where tax is not inclusive.
Parent topic:Working with Products

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 Commerce Engine-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

Product Pricing Pane

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

Field	Guidance	Relevancy
Model	Toggle to define the Pricing Mechanism. Toggle right for currency Standard Pricing or left for license-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
Rate Plan	Rate plans are license-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

Custom Data

Custom data lets you store Reseller (Service Provider)-specific data to Products 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. To define a name-value pair:

Use Name to define a category.
Use Value to define a specific item in that category.
Select Add to save the pair.

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. Note:

Name is a unique field and once submitted can’t be changed.
Each field is limited to 255 characters.
System generated parameters use the prefix vin in the name field.

Eligibility Rule Fields

To apply eligibility rules, refer to the table below for field names, descriptions, value sources, and example values.

Field Name	Description	Required	Value Source	Example Value
maxUsage	The product can be used up to the specified number of times per customer. For example, if the limit is set to `1`, a customer who cancels and repurchases the offer will not receive the product again.	No	N/A	`1`
maxUsageActive	The customer can have up to the specified number of active products at a time. For example, if the limit is set to `1`, the customer becomes eligible for the product again only after it becomes inactive, expires, or they cancel.	No	N/A	`1`
quantityRange	The eligible range for the total number of products a user can have—combining both existing active subscription products and new purchases. For example: `2:5` denotes two to five products is the eligible range.	No	N/A	`2:5`
tier	The eligible customer account attribute (tier). To apply multiple tiers, enter each tier in the Value field, separated by commas. For example: `Tier1,Tier2`. If you specify multiple tiers, the customer must have all the specified tiers to be eligible for the product.	No	The tier name in the Reseller’s systemNote: If the customer account tier metadata includes multiple comma-separated values, the customer is eligible for the product as long as any one of those values matches a tier you’ve specified for the product in Commerce Engine.	`GoldTier`
trialGroup	The identifier of the free trial to apply to the product. See Configuring Eligibility Rules for configuration examples.	No	Billing plan in Commerce Engine	`Product_Free_Trial`
Parent topic:Working with Products

Required Custom Data

In this section, select each required field from the dropdown menu and enter the appropriate value for your product configuration. These values may originate from various sources, including billing plans within the application or other product components (e.g., Partner Ecosystem Management). Refer to the table below for field names, descriptions, value sources, and example values.

Field Name	Description	Required	Value Source	Example Value
PLM-CODE	The product identifier from Partner Ecosystem Management.	Yes	Partner Ecosystem Management	`PRODUCT.0002-0002-0002-0002`
BILLING-OPTION-1	The identifier of the billing plan to associate with the product.	Required if using the standalone marketplace (e.g., the full MarketONE suite). Not required for headless marketplace deployments.	Billing plan in Commerce Engine	`MonthlyBillingPlan`
canUpgradeTo	The identifier of the product that customers can upgrade to. To specify multiple upgrade options, enter each product identifier in the Value field, separated by commas. For example: PROD1,PROD2.	Required if: - The Merchant product is part of a group with multiple products - The Merchant supports switching	Other product(s) in Commerce Engine	`ProductPremium`
canDowngradeTo	The identifier of the product that customers can downgrade to. To specify multiple downgrade options, enter each product identifier in the Value field, separated by commas. For example: PROD1,PROD2.	Required if: - The Merchant product is part of a group with multiple products - The Merchant supports switching	Other product(s) in Commerce Engine	`ProductBasic`
Parent topic:Working with Products

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

Product Details Pane

Product Description Pane

Product Pricing Pane

Custom Data

Eligibility Rule Fields

Required Custom Data

​Product Details Pane

​Product Description Pane

​Product Pricing Pane

​Custom Data

​Eligibility Rule Fields

​Required Custom Data

Product Details Pane

Product Description Pane

Product Pricing Pane

Custom Data

Eligibility Rule Fields

Required Custom Data