Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > RatePlanChargeTier

RatePlanChargeTier

A rate plan charge tier is part of a subscription or an amendment to a subscription, and it comes from a product rate plan charge tier. A rate plan charge tier holds the prices for a rate plan charge. Each rate plan charge has at least one tier associated with it.

Rate plan charge tiers are sometimes called subscription rate plan charge tiers to distinguish them from product rate plan charge tiers. Rate plan charge tiers that are part of an amendment are sometimes called amendment rate plan charge tiers for the same reason. However, the object name is RatePlanChargeTier, not SubscriptionRatePlanChargeTier nor AmendmentRatePlanChargeTier: these latter two names don't exist.

Don't confuse a rate plan charge tier with tiered pricing. Tiered pricing is a charge model in which you create different charges or tiers for different quantities of an item.

Use the RatePlanChargeTier object to represent a tier of charges in a RatePlanCharge object. The RatePlanChargeTier object exists only within a subscription. You can't create a RatePlanChargeTier directly; you create it when you use a subscribe() call to create a new subscription or an amend() call to add a new product to an existing subscription. You can then update the RatePlanChargeTier object to override some of its settings.

Supported Calls

You can use this object with the following calls:

Field Descriptions

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.

Name Required? Allowed Operations Description
CreatedById optional

Query
Filter

The ID of the Zuora user who created the RatePlanChargeTier object.

Type: zns:ID
Character limit: 32
Version notes: WSDL 20.0+
Values: automatically generated

CreatedDate optional

Query
Filter

The date when the RatePlanChargeTier object was created.

Type: dateTime
Character limit: 29
Version notes: WSDL 20.0+
Values: automatically generated

EndingUnit optional

Query
Filter

The end number of a range of units for the tier.

Type: decimal
Character limit: 16
Version notes: type is double for WSDL 18.0 and older
Values: any positive decimal value

Id optional Query
Filter

The ID of this object. Upon creation, the ID of this object is RatePlanChargeTierId.

Type: zns:ID
Character limit: 32
Version notes: --
Values: automatically generated

IsOveragePrice optional

Query
Update
Filter

Indicates if the price is an overage price. An overage occurs when usage surpasses the last defined tier. This field is applicable only to tier pricing and volume pricing models.

Type: boolean​
Version notes: WSDL 8.0+
Values: truefalse

Price optional

Query
Update
Filter

The price of the tier if the charge is a flat fee, or the price of each unit in the tier if the change model is tiered pricing.

Type: decimal
Character limit: 16
Version notes: type is double for WSDL 18.0 and older
Values: any positive decimal value

PriceFormat optional

Create
Query
Update
Delete
Filter

Indicates if the price is a flat fee or is per unit.

Type: string
Character limit: 8
Version notes: WSDL 8.0+
Values: Flat Fee, Per Unit

RatePlanChargeId required

Create
Query
Update
Delete
Filter

The ID of the subscription or amendment rate plan charge associated with this tier. You can't create an unassociated tier.

Type: zns:ID
Character limit: 32
Version notes: --
Values: inherited from RatePlanCharge.Id

StartingUnit optional

Query
Filter

The start number of a range of units for the tier.

Type: decimal
Character limit: 16
Version notes: type is double for WSDL 18.0 and older
Values: any positive decimal value

Tier optional

Query
Filter

A unique number that identifies the tier that the price applies to.

Type: bigint
Character limit: 20
Version notes: --
Values: automatically generated

UpdatedById optional

Query
Filter

The ID of the last user to update the object.

Type: zns:ID
Character limit: 32
Version notes: WSDL 20.0+
Values: automatically generated

UpdatedDate optional

Query
Filter

The date when the object was last updated.

Type: dateTime
Character limit: 29
Version notes: --
Values: automatically generated

Additional Field Detail

EndingUnit

The end number of a range of units for the tier. For example, if the tier stipulates 101 - 200 minutes, then the value for the EndingUnit field is 200.

This field is required if RatePlanCharge.ChargeModel is Tiered Pricing or Tiered with Overage Pricing. Use this field only for tiered pricing models.

Id

The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscriptionobject's ID with the call.

The ID for the RatePlanChargeTier object is RatePlanChargeTierId.

StartingUnit

The start number of a range of units for the tier. For example, if the tier stipulates 101 - 200 minutes, then the value for the StartingUnit field is 101.

This field is required if RatePlanCharge.ChargeModel is Tiered Pricing or Tiered with Overage Pricing. Use this field only for tiered pricing models.



 

Last modified
12:50, 14 Jul 2017

Tags

Classifications

(not set)