RatePlanChargeTier

From API Documentation

A RatePlanChargeTier represents one tier of charges for a RatePlanCharge. Each rate plan charge can have 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.

Supported Calls

This object is used in 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
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.
EndingUnit	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. The starting and ending units only exist (and therefore, are only required) if the parent rate plan charge object has its ChargeModel set to Tiered or TieredWithOverage.
IsOveragePrice	No	boolean	○ Create ● Query ● Update ○ Delete ● Filter	True, False, Null. Defaults to Null, not false.	Available in version 9.0+ of the API. Specifies if the price is the overage price. Only applicable to tiered and volume price models.
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	See description	string	● Create ● Query ● Update ● Delete ● Filter	Per Unit, Flat Fee	The format for the price for this tier, such as flat fee or per-unit. This is a read-only field, and it cannot be null.
RatePlanChargeId	Yes	zns: ID	● Create ● Query ● Update ● Delete ● Filter	This is automatically assigned by the system	The identification number of the rate plan charge ID to which this tier applies.
StartingUnit	Depends—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. The starting and ending units only exist (and therefore, are only required) if the parent rate plan charge object has its ChargeModel set to Tiered or TieredWithOverage.
Tier	Yes	int	○ Create ● Query ○ Update ○ Delete ● Filter	This is automatically assigned 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

RatePlanCharge