Product Rate Plan
Product Rate Plan
A product rate plan is the part of a product that your customers subscribe to. Each product can have multiple product rate plans, and each product rate plan can have multiple product rate plan charges, which are fees for products and their product rate plans.
Don't confuse a product rate plan and a rate plan. A product rate plan is a rate plan that's part of a product in your product catalog. A rate plan is the specific rate plan in a subscription.
Use the ProductRatePlan object to define the services that make up the Product objects that can be associated with Subscription objects.
The set of (Product objects, ProductRatePlan objects, ProductRatePlanCharge objects) is a defined set of products that a company sells
Field Descriptions
| Name | Required to Create? | Description |
|---|---|---|
| Product Rate Plan Id | required | The ID of this object. Upon creation, the ID of this object is ProductRatePlanId. |
| Name | required | The name of the product rate plan. The name doesn't have to be unique in a Product Catalog, but the name has to be unique within a product. |
| Description | optional | A description of the product rate plan. |
| ActiveCurrencies | required | A comma-separated list of 3-letter currency codes representing active currencies for this rate plan, e.g., "USD, EUR, CAD, GBP". |
| ProductId | required | The ID of the product that contains the product rate plan. |
| EffectiveStartDate | required | The date when the product rate plan becomes available and can be subscribed to. Format of date is DD-MM-YYYY |
| EffectiveEndDate | Optional | The date when the product rate plan expires and can't be subscribed to. Format of date is DD-MM-YYYY. Default value is 31-12-9999. |