ProductRatePlanChargeTier

From API Documentation

A ProductRatePlanChargeTier represents one tier of charges for a ProductRatePlanCharge. Each rate plan charge has one or more tiers associated with it. The tiers can be, for example, different charges for different quantities of an item. As an example of a rate plan charge tier, there might be different charges for different quantities of an item: 1 to 400 text messages would have one price, and that would be one tier; 401 to 800 text messages would have another price, and that would be a second tier; and so on.

Tip: Do not confuse ProductRatePlanChargeTier with tiered pricing. Every ProductRatePlanCharge has at least one tier associated with it, no matter what the charge model is. Pricing information is stored on the ProductRatePlanChargeTier.

Important: You can create a ProductRatePlanChargeTier only as part of a ProductRatePlanCharge.

Supported Calls

This object is used in the query and create 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
Active	Yes	boolean	● Create ● Query ● Update ● Delete ● Filter	True or False	Specifies whether the tier is active.
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.
Currency	Yes	string	○ Create ● Query ○ Update ○ Delete ● Filter	Allowable values are defined in the Admin interface.	The currency types being used for this tier.
EndingUnit	Depends—see Description	double (v1.0-18.0) / decimal (v19.0+)	○ Create ● Query ○ Update ○ Delete ● Filter	Any positive number	The ending unit for this tier for the rate plan charge that it applies to. For example, if this tier is for 1 to 100 minutes, the ending unit would be 100. This is required if the object belongs to a product with a product rate plan charge Model set to Tiered or TieredWithOverage.
IsOveragePrice	No. Defaults to null, not false.	boolean	○ Create ● Query ○ Update ○ Delete ● Filter	True, false, null	Available in version 8.0+ of the API. Only used for volume and tiered pricing models. The price applied when number of units has surpassed the last defined tier.
Price	Yes	double (v1.0-18.0) / decimal (v19.0+)	○ Create ● Query ● Update ○ Delete ● Filter	Any positive number	The price for this tier (if a flat fee) or for each unit in this tier (if the charges are per unit).
PriceFormat	No	string	● Create ● Query ● Update ● Delete ● Filter	"Flat Fee" and "Per Unit"	Available in version 8.0+ of the API. Determines whether pricing is per unit for a flat fee. Applies to tiered and volume pricing models only.
ProductRatePlanChargeId	Yes	zns: ID	● Create ● Query ● Update ● Delete ● Filter	This is automatically assigned by the system	The identification number of the product rate plan charge to which this tier applies. You can create a ProductRatePlanChargeTier only as part of a ProductRatePlanCharge.
StartingUnit	See Description	double (v1.0-18.0) / decimal (v19.0+)	○ Create ● Query ○ Update ○ Delete ● Filter	Any positive number	The starting unit for this tier for the rate plan charge that it applies to. For example, if this tier is for 1 to 100 minutes, the starting unit would be 1. This is required if the object belongs to a product with a product rate plan charge Model set to Tiered or TieredWithOverage.
Tier	Yes	int	○ Create ● Query ○ Update ○ Delete ● Filter	This is automatically generated by the system	The identification of the tier that this charge applies to.
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

• Product
• ProductRatePlanCharge