Open topic with navigation
Open topic with navigation
ProductRatePlanCharge
A ProductRatePlanCharge, like ProductRatePlan, is part of a Product. Each product can have one or more rate plans, and each rate plan can have one or more rate plan charges. Rate plan charges are actual charges for services you are giving, and can be of different types; for example, one-time fees, monthly recurring fees, usage-based fees, and so on.
Supported Calls
This object is used in the query call.
Fields
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name |
Required? |
Type |
Allowable Values |
Description |
| AccountingCode |
No |
string |
50 characters |
This can be used for entering your accounting code for this charge. |
| DefaultQuantity |
Yes if using the PerUnit pricing model; NA otherwise |
double |
Any positive value |
The default quantity for this rate plan charge. For example, if the rate plan charge applies to minutes in a phone plan, this would be the default quantity of minutes allowed for this rate plan charge. |
| Description |
No |
string |
255 characters |
A description of this rate plan charge. |
| MaxQuantity |
No |
double |
Any positive value |
The maximum allowed quantity for this rate plan charge. For example, if the rate plan charge applies to minutes in a phone plan, and there is some flexibility in the number of minutes allowed for this rate plan charge, enter the maximum number of minutes that are allowed. |
| MinQuantity |
No |
double |
Any positive value |
The minimum allowed quantity for this rate plan charge. |
| Model |
Yes |
string (enum) |
FlatFee, PerUnit, Overage, Tiered, TieredWithOverage, Volume |
The charge model for this rate plan charge. |
| ProductRatePlanId |
Yes |
zns: ID |
A valid product rate plan ID |
The identification number of the product rate plan to which this rate plan charge applies. |
| Type |
Yes |
string (enum) |
OneTime, Recurring, Usage |
The type of charge that this is. |
| UOM |
No |
string |
Allowable values are predefined in the Zuora admin interface |
This is the unit of measure: People, minutes, or whatever unit is being used for this rate plan charge. |
See Also
Product
ProductRatePlan
Copyright © 2008-2009 Zuora, Inc.
Open topic with navigation
Open topic with navigation