RatePlan

From API Documentation

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	Allowed Operations: ● Yes ○ No	Allowable Values	Description
AmendmentId	Only when used with an amendment. Not used with subscribe() and subcribeWithExistingAccount().	zns:ID	○ Create ● Query ○ Update ○ Delete ● Filter	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	Only when used with RemoveProduct and UpdateProduct amendments. Not used with subscribe() and subcribeWithExistingAccount().	zns:ID	● Create ● Query ● Update ● Delete ● Filter	A valid rate plan ID	The identification number of the subscription rate plan that the amendment is modifying. Required if AmendmentType is set toRemoveProduct or UpdateProduct.
AmendmentType	Only when used with an amendment. Not used otherwise.	string	○ Create ● Query ○ Update ○ Delete ● Filter	Cancellation, NewProduct, OwnerTransfer, RemoveProduct, Renewal, TermsAndConditions, UpdateProduct	The type of amendment being made.
CreatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	32 characters maximum. This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who created the object.
CreatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was first created.
Name	Yes	string	○ Create ● Query ○ Update ○ Delete ● Filter	50 characters	The name of the subscription rate plan. If you leave this blank in subscribe() or subscribeWithExistingAccount in the RatePlanData object, the RatePlan will inherit the name of ProductRatePlan it is descended from.
ProductRatePlanId	Yes	zns:ID	○ Create ● Query ○ Update ○ Delete ● Filter	A valid product rate plan ID	The ID of the ProductRatePlan.
SubscriptionId	Yes	zns: ID	○ Create ● Query ○ Update ○ Delete ● Filter		The identification number of a valid subscription. A subscription has a one-to-many relationship with SubscriptionRatePlan. When you create a subscription, the Product Rate Plans that you select will be copied and stored as related RatePlans.
UpdatedById	System generated, always exists	ZNS:Id	○ Create ● Query ○ Update ○ Delete ● Filter	32 characters maximum. This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this Id of the user who last updated the object.
UpdatedDate	System generated, always exists	dateTime	○ Create ● Query ○ Update ○ Delete ● Filter	This field is not editable.	Available as of version 20.0 of the API. The Zuora system automatically generates this, and denotes when the objects was last updated.

See Also

• RatePlanCharge
• Subscription