Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > ProductRatePlanChargeTier

ProductRatePlanChargeTier

A product rate plan charge tier holds the prices for a product rate plan charge. Each product rate plan charge has at least one tier associated with it. Use the ProductRatePlanChargeTier object to represent a tier of charges in a ProductRatePlanCharge object.

Don't confuse a product rate plan charge tier with tiered pricing. Tiered pricing is a charge model in which you create different charges or tiers for different quantites of an item.  The tiers of usage fees in the Product: Family Plan example diagram represented tiered pricing. Each product rate plan charge in the diagram has at least one tier.

productrateplan-diagram.png

 

Supported calls

You can use this object with the following calls:

Limitations

You can't create a ProductRatePlanChargeTier object independently of an associated ProductRatePlanCharge object.

You can use only one of the following fields in an API query of the ProductRatePlanChargeTier object:

  • Price
  • DiscountAmount
  • DiscountPercentage

The following is a query that will result in an error:

select id, discountPercentage, price from ProductRatePlanChargeTier where ProductRatePlanChargeId = '402892a338501b82013850ca211f002c'

The following INVALID_VALUE error message:

Can only use Price or DiscountAmount or DiscountPercentage in one ProductRatePlanChargeTier query.

Walkthroughs and use cases

Here are some common ways to use this object:

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 to Create? Allowed Operations Description

Active

required*

Create
Query
Update
Filter

Determines whether the tier is active. This field is deprecated as of release R163 / WSDL 46.0 (April 2013).

Typeboolean
Character limit: 5
Version notes: --
ValuesTrue, False

CreatedById optional

Query
Filter

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

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

CreatedDate optional

Query
Filter

The date when the 
ProductRatePlanChargeTier object was created.

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

Currency required

Query
Filter

The code corresponding to the currency for the tier's price.

Typestring
Character limit: 3
Version notes:
Values: a valid currency code

DiscountAmount optional Create
Query
Update
Filter
The specific amount for a fixed discount. This field is required if the value for ProductRatePlanCharge.ChargeModel is Discount-Fixed Amount.

Typedecimal
Character limit: 16
Version notes: WSDL 41.0+
Values: any positive decimal value

DiscountPercentage optional Create
Query
Update
Filter
The percentage of discount for a percentage discount. This field is required if the value for ProductRatePlanCharge.ChargeModel is Discount-Percentage.

Typedecimal
Character limit: 16
Version notesWSDL 41.0+
Values: a decimal value between -100 and 100, exclusive

EndingUnit optional

Query
Filter

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

Typedecimal
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 ProductRatePlanChargeTierId.

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

IsOveragePrice optional

Query
Filter

Indicates if the price is an overage price, which is the price when usage surpasses the last defined tier.

Typeboolean
Character limit: 5
Version notes: WSDL 8.0+
ValuesTrue, false

Price required

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 charge model is tiered pricing.

Typedecimal (currency)
Character limit: 16
Version notes: type is double for WSDL 18.0 and older
Values: a valid currency value

PriceFormat optional

Create
Query
Update
Filter

Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only.

Typestring (enum)
Character limit: 8
Version notes: WSDL 8.0+
ValuesFlatFee, PerUnit

Note: The values Flat Fee and Per Unit (with spaces) is valid for create or update calls.

ProductRatePlanChargeId required

Create
Query
Update
Filter

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

Typezns:ID
Character limit: 32
Version notes: --
Values: a valid product rate plan charge ID

StartingUnit optional

Query
Filter

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

Typedecimal
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:
Valuesautomatically generated

UpdatedById optional

Query
Filter

The ID of the user who last updated the product rate plan charge tier.

Typezns:ID
Character limit: 32
Version --
Values: automatically generated

UpdatedDate optional

Query
Filter

The date when the product rate plan charge tier was last updated.

TypedateTime
Character limit: 29
Version --
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 ProductRatePlanCharge.ChargeModel is Tiered Pricing or Tiered with Overage Pricing.

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 InvoiceItem object is InvoiceItemId.

StartingUnit

The starting 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 ProductRatePlanCharge.ChargeModel is Tiered Pricing or Tiered with Overage Pricing.

Last modified
17:48, 16 Mar 2016

Tags

Classifications

(not set)