Product
A product is an item or service that your company sells. In the subscription economy, a product is generally a service that your customers subscribe to rather than a physical item that they purchase one time. For example, customers subscribe to a service that provides them a car when and where they need a car rather than buying a car outright.
A Product object contains all of the items in a specific product, especially product rate plans and product rate plan charges. Each Product object can have multiple rate plans, which in turn can each have multiple rate plan charges. Each rate plan charge can have multiple tiers. Taken together, all of these items create a single product.
Customers subscribe to products that are in your product catalog. Product objects collectively compose your product catalog. You create your product catalog by creating products. As soon as you create your first product, you create your product catalog.
You use the Product object to identify what is in the product catalog, and to identify the product rate plan ID that you need for a subscribe() call to create a subscription.
The set of (Product objects, ProductRatePlan objects, ProductRatePlanCharge objects) is a defined set of products that a company sells, such as in the example, Family Plan, Topaz level.
Here are some common ways to use this object:
- Create products in the product catalog
- Update existing products in the product catalog
- Modify rate plans
- Modify rate plan charges
Field Descriptions
| Name | Required to Create? | Description |
|---|---|---|
| Product Id | required | Unique Id of product. Created upon production creation. |
| Name | required | The name of the product. |
| Description | optional | A descriptionof the product. |
| Category | required | Category of the product. Values: One of the following: - Base Products - Add On Services - Miscellaneous Products |
| EffectiveStartDate | required | The date when the product becomes available and can be subscribed to. Format of date is DD-MM-YYYY |
| EffectiveEndDate | Optional | The date when the product expires and can't be subscribed to anymore. Format of date is DD-MM-YYYY. Default value is 31-12-9999. |