ProductRatePlan
From API Documentation
A ProductRatePlan is part of a Product, which in turn can be associated with one or more Subscriptions. A rate plan is what your customer is signing up for. Each product can have one or more product rate plans, and each product rate plan can have one or more product rate plan charges. Rate plan charges are the actual charges for the services (rate plans) that you are giving, and can be of different types; for example, one-time fees, monthly recurring fees, usage fees, and so on.
Contents |
Supported Calls
This object is used in the query call.
Using the ProductRatePlan Object
This object is used to create different product rate plans for products. For example, let's say you have a product named Alpha Subscription, and you want to offer your users different payment options ($10 per month with a $40 setup fee, or if they subscribe for a year, then it costs $100 per year and the setup fee is waived; in other words, a $0 setup fee).
In this example:
- You would first create the one product, which you might name call "Alpha Subscription."
- Then, for the Alpha Subscription product, you would create two different product rate plans. In this case, you might create a monthly product rate plan for Alpha Subscription.
- You would then add two rate plan charges to the monthly product rate plan: a flat fee, one-time product rate plan charge of $40, and a recurring product rate plan charge of $10 that recurs monthly.
- Next, you might create another product rate plan, say, a yearly product rate plan for Alpha Subscription.
- You would then add to that second product rate plan a recurring product rate plan charge of $100 that recurs annually. Since you are waiving the setup fee, there is no need to create a one-time setup fee.
Now you have two product rate plans for the same product. This would allow you to sign up users to the same product with different payment plans (rate plans).
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 |
|---|---|---|---|---|---|
| CreatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | 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 | 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. |
| Description | No | string | ● Create
● Query | 500 characters maximum | A description of the rate plan. |
| EffectiveEndDate | Yes | dateTime | ● Create
● Query | A valid dateTime value | The date on which the rate plan expires or is no longer valid. |
| EffectiveStartDate | Yes | dateTime | ● Create
● Query | A valid dateTime value | The date on which the rate plan becomes available. |
| Name | Yes | string | ● Create
● Query | 100 characters maximum | The name of the rate plan. |
| ProductId | Yes | zns: ID | ● Create
● Query | A valid product ID | The identification number of the product that this rate plan is for. |
| UpdatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | 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 | 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. |
