A product rate plan charge represents a charge model or a set of fees associated with a product rate plan.
A product rate plan charge represents a charge model or a set of fees associated with a product rate plan, which is the part of a product that your customers subscribe to. Each product rate plan can have multiple product rate plan charges.
Do not confuse a product rate plan charge with a rate plan charge. A product rate plan charge is a charge that's part of a product in your product catalog. A rate plan charge is the specific charge in a subscription.
Use the ProductRatePlanCharge object to define the charges for the ProductRatePlan objects that customers subscribe to.
Product rate plan charges can be of three types: one-time fees, recurring fees, and usage fees. For example, the $50 activation fee for the Topaz product rate plan is a one-time product rate plan charge.
The set of (Product objects, ProductRatePlan objects, ProductRatePlanCharge objects) is a defined set of products that a company sells, such as in the Family Plan example.
Field Descriptions
| Name | Required to Create? | Description |
|---|---|---|
| Product Rate Plan Charge Id | required | Unique Id of product rate plan charge. Created upon product rate plan charge creation. |
| Name | required | The name of the product rate plan charge. |
| Description | optional | A description of the product rate plan charge. |
| ChargeModel | required | Determines how to calculate charges. Values: One of the following: - Flat Fee Pricing - Per Unit Pricing - Overage Pricing - Tiered Pricing - Tiered with Overage Pricing - Volume Pricing - Discount-Fixed Amount - Discount-Percentage |
| ChargeType | required | Specifies the type of charge. Values: One of the following: - One-Time - Recurring - Usage |
| ListPriceBase | required | The list price base for the product rate plan charge. Values: One of the following: - Per Day - Per Month |
| UOM | required | Specifies the units to measure usage. Note: You must specify this field when creating the following charge models: - Per Unit Pricing - Volume Pricing - Overage Pricing - Tiered Pricing - Tiered with Overage Pricing |
| Currency | required | |
| PerUnitPrice | optional | Per unit price. Only needs to be populated in case Per Unit Pricing model |
| IncludedUnits | optional | Specifies the number of units in the base set of units. |
| TaxExclusivePrice | required | Price of charge excluding Tax |
| TaxInclusivePrice | required | Priced of charge including Tax. Tax Exclusive Price and Tax Inclusive Price are same if Taxable is false |
| Taxable | required | Flag to indicate whether charge is taxable or not |
| TaxAmount | optional | Amount of Tax needs to be paid. Only populated if Taxable is true |
| Status | required | Status of the charge Possible values are: - Active - Inactive |