Open topic with navigation
Open topic with navigation
RatePlan
A RatePlan is part of a Subscription. Each subscription can have one or more rate plans, and each rate plan can have one or more rate plan charges. A rate plan is essentially a price or a collection of prices for a service you are offering.
When a RatePlan object of type NewProduct is created as part of an Amendment, the ProductRatePlans and ProductRatePlanCharges from the corresponding Product are created automatically as RatePlans and RatePlanCharges on the Amendment. To update a particular RatePlanCharge, you need to first query it and then update the desired field (Quantity) by ID.
Supported Calls
This object is used with the create and query calls.
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 |
| AmendmentId |
Yes |
zns: ID |
A valid amendment ID |
The identification number of the amendment that the RatePlan is associated to, if it is an amendment rate plan. (It is an amendment rate plan if the amendment ID is not null). |
| AmendmentSubscriptionRatePlanId |
Depends on usage |
zns: ID |
A valid rate plan ID |
The identification number of the subscription rate plan that the amendment is modifying. Required if Type is set to RemoveProduct or UpdateProduct. |
| AmendmentType |
Yes |
string |
NewProduct, RemoveProduct, TermsAndConditions, UpdateProduct, |
The type of amendment being made. |
| Name |
Yes |
string |
50 characters |
The name of the subscription rate plan. |
| ProductRatePlanId |
Depends on usage |
zns: ID |
NA |
The identification number of a valid product rate plan. Required if Type is set to NewProduct. |
| SubscriptionId |
Yes |
zns: ID |
NA |
The identification number of a valid subscription. |
See Also
RatePlanCharge
Subscription
Copyright © 2008-2009 Zuora, Inc.
Open topic with navigation
Open topic with navigation