ProductRatePlanCharge
From API Documentation
A ProductRatePlanCharge, like ProductRatePlan, is part of a Product. Every product can have one or more rate plans, and each rate plan can have one or more rate plan charges. Rate plan charges are actual charges for services you are providing, and can be of different types. For example, one-time fees, monthly recurring fees, and usage-based fees.
Use ProductRatePlanChargeTier to create tiers for a rate plan charge. For example, you might want to create different charges for different quantities of an item: 1 to 400 text messages might have one price, either as a flat rate or per unit, for example, and that would be one tier; 401 to 800 text messages might have another price, and that would be a second tier.
See Create a Product Rate Plan Charge with Pricing Information for information about creating product rate plan charges, including required fields.
| Name | Required? | Type | Allowed Operations: ● Yes ○ No | Allowable Values | Description |
|---|---|---|---|---|---|
| AccountingCode | No | string | ● Create
● Query | 100 characters maximum | This can be used to enter your accounting code for this charge. |
| BillCycleDay | No | int | ● Create
● Query | 1-31 | Determines the default bill cycle day for a given charge if not set at the Account or Subscription level. Leave this field Null, unless BillCycleType is set to SpecificDayofMonth. |
| BillCycleType | Required (as of version 26.0) | string | ● Create
● Query | DefaultFromCustomer, SpecificDayofMonth, SubscriptionStartDay, ChargeTriggerDay | Specifies how the billing day for the charge should be determined - from the default day on the customer account (most common), specific day (must specify with BillCycleDay), the day the subscription starts or the day the charge is triggered. |
| BillingPeriod | Yes | string | ● Create
● Query | Month, Quarter, Annual, Semi-Annual, Specific Months
(Specific Months is only available in Version 27.0+ of the API.) | The billing period of a charge.
Note: If you specify Specific Months, you must also set the SpecificBillingPeriod field. |
| BillingPeriodAlignment | No | string | ● Create
● Query | AlignToCharge, AlignToSubscriptionStart, AlignToTermStart | Determines how the charge should be aligned. Monthly charges are always aligned to charge. Most useful for when adding yearly, quarterly or semiannual charges to an existing subscription to determine proration rules and billing alignment.
If the associated charge is not a one-time charge, the default value is AlignToCharge. |
| ChargeModel | Yes | string (enum) | ● Create
● Query | Discount-Fixed Amount, Discount-Percentage, Flat Fee Pricing, Per Unit Pricing, Overage Pricing, Tiered Pricing, Tiered with Overage Pricing, Volume Pricing | Available as of version 20.0. The charge type for this rate plan charge. Replaces Model.
Note: You cannot create a Discount-Fixed Amount or Discount-Percentage type of ChargeModel. |
| ChargeType | No | string (enum) | ● Create
● Query | OneTime, Recurring, Usage | Available as of version 20.0. The charge type for this rate plan charge. Replaces Type. |
| 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. |
| DefaultQuantity | Yes if using the PerUnit pricing model; No otherwise | double (v1.0-18.0) / decimal (v19.0+) | ● Create
● Query | Any positive value | The default quantity for this rate plan charge. For example, if the rate plan charge applies to minutes in a phone plan, this would be the default quantity of minutes allowed for this rate plan charge. |
| Description | No | string | ● Create
● Query | 500 characters maximum | A description of this rate plan charge. |
| IncludedUnits | No | decimal | ● Create
● Query | For usage-based fees, specify the number of units to include (free units, at no cost to the customer) in the base set of units.
Note: This field is not supported for use with tiered or volume pricing. | |
| MaxQuantity | No | double (v1.0-18.0) / decimal (v19.0+) | ● Create
● Query | Any positive value | The maximum allowed quantity for this rate plan charge. For example, if the rate plan charge applies to minutes in a phone plan, and there is some flexibility in the number of minutes allowed for this rate plan charge, enter the maximum number of minutes that are allowed. |
| MinQuantity | No | double (v1.0-18.0) / decimal (v19.0+) | ● Create
● Query | Any positive value | The minimum allowed quantity for this rate plan charge. |
| Model | Yes | string (enum) | ● Create
● Query | FlatFee, PerUnit, Overage, Tiered, TieredWithOverage, Volume (Versions 4.0-19.0) | The charge model for this rate plan charge. (Deprecated as of version 20.0. Use ChargeModel as of version 20.0. Name change for consistency sake across Zuora API.) |
| Name | Yes | string | ● Create
● Query | 100 characters maximum | The name of the charge. |
| NumberOfPeriod | No | integer | ● Create
● Query | Define the number of periods to use when using an overage smoothing charge model. | |
| OverageCalculationOption | No, only used for Usage charges that have Overage or Tiered With Overage charge models. | string | ● Create
● Query | EndOfSmoothingPeriod (default), PerBillingPeriod | Specifies how Zuora should calculate overage, whether to calculate at the end of the smoothing period or per billing period. |
| OverageUnusedUnitsCreditOption | No, only used for Usage charges that have Overage or Tiered With Overage charge models. | string | ● Create
● Query | NoCredit (default), CreditBySpecificRate | Specifies how Zuora should handle unused units of usage, whether or not credit is given to the customer. |
| PriceIncreaseOption | No | string | ● Create
● Query | FromTenantPercentageValue, SpecificPercentageValue | Enable the Automated Price Change (Uplift) for Renewed Subscriptions feature. See Automated Price Change (Uplift) for Renewed Subscriptions for more information. |
| PriceIncreasePercentage | No | decimal | ● Create
● Query | A positive or negative integer from 0 to 100 or 0 to -100. | Specify the percentage to increase or decrease the price of renewed subscriptions. See Automated Price Change (Uplift) for Renewed Subscriptions for more information. |
| ProductRatePlanId | Yes | zns: ID | ● Create
● Query | A valid product rate plan ID | The identification number of the product rate plan to which this rate plan charge applies. |
| RevRecCode | No | string | ● Create
● Query | A valid revenue recognition code set within Z-Billing settings. | The revenue recognition code for the given charge. Used for facilitating recognizing revenue within accounting systems or reporting. |
| RevRecTriggerCondition | No | string | ● Create
● Query | ContractEffectiveDate, ServiceActivationDate, CustomerAcceptanceDate. | The condition when revenue recognition should begin. Used for facilitating recognizing revenue within accounting systems or reporting. |
| SmoothingModel | No | string | ● Create
● Query | RollingWindow, Rollover | Use a smoothing model to avoid spikes and troughs in usage charges in any given month. See Overage Smoothing Model for more information. |
| SpecificBillingPeriod | Required if BillingPeriod is to "Specific Months." | long | ● Create
● Query | Valid, positive integer | Sets the billing period of a charge to a custom value (in months). When charging a customer annually, semi-annually, quarterly, or monthly, it is recommended to not use this, and set BillingPeriod to desired billing period. Only available in versions 27.0+ of the API. |
| Taxable | No, only available to customers of Z-Taxation | boolean | ● Create
● Query | true/false | Determines whether a charge is subject to taxation. Available to customers of Z-Taxation only. |
| TaxCode | No, only available to customers of Z-Taxation | string | ● Create
● Query | A valid tax code, 64 characters maximum | Sets the tax code for taxation rules. Available to customers of Z-Taxation only |
| TriggerEvent | Yes | string | ● Create
● Query | ContractEffective, ServiceActivation, CustomerAcceptance, SpecificDate | Defines when billing for the charge should begin. |
| Type | Yes | string (enum) | ● Create
● Query | OneTime, Recurring, Usage (Versions 4.0-19.0) | The charge type for this rate plan charge. (Deprecated as of version 20.0. Please use ChargeType as of version 20.0. Name change for consistency sake across Zuora API.) |
| UOM | No | string | ● Create
● Query | Allowable values are defined in the Admin interface | This is used to measure use of your services. |
| 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. |
| UseDiscountSpecificAccountingCode | No | boolean | ○ Create
● Query | true, false | If this is set to true, the accounting code will be copied from another (non-discount) charge. If this is false, you can define a dedicated accounting code on the new discount charge.
|
