Skip to main content

Product Rate Plan Charge - Data dictionary

Zuora

Product Rate Plan Charge - Data dictionary

This page details the fields associated with the Product Rate Plan Charge Data dictionary. Read more about Product rate plan charges here

Note: Fields with an asterisk mark indicate mandatory fields. 

 

Name Description Value
IsNewProductRatePlanCharge Marker Column TRUE
Bill Cycle Type* Specifies how to determine the billing day for the charge String
Billing Period* The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). String
Charge Model* Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration. String
Charge Type* Specifies the type of charge String
Name* The name of the product rate plan charge. string <= 100 characters
Product Rate Plan Id* The ID of the product rate plan associated with this product rate plan charge. string <= 32 characters
Trigger Event* Specifies when to start billing the customer for the charge string
UseDiscountSpecificAccountingCode* Determines whether to define a new accounting code for the new discount charge. boolean or null
Accounting Code The accounting code for the charge. string <= 100 characters
Apply Discount To

Specifies the type of charges that you want a specific discount to apply to. All field values are case-sensitive and in all-caps.

Enum: "ONETIME (1)" "RECURRING (2)" "USAGE (4)" "ONETIMERECURRING (3)" "ONETIMEUSAGE (5)" "RECURRINGUSAGE (6)" "ONETIMERECURRINGUSAGE (7)"

string
BillCycleDay

Sets the bill cycle day (BCD) for the charge.

The BCD determines which day of the month the customer is billed. The BCD value in the account can override the BCD in this object. Character limit: 2 Values: a valid BCD integer, 1 - 31

integer <int32>
Billing Period Alignment Aligns charges within the same subscription if multiple charges begin on different dates string
Billing Timing The billing timing for the charge. For recurring charge types, you can choose to bill in advance or in arrears. This field is not used in one-time or usage-based charge types. string
ChargeFunction This field is only available if you have the Unbilled Usage feature enabled. string
CommitmentType This field is only available if you have the Unbilled Usage feature enabled. string
Class NS Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Credit Option This field is only available if you have the Prepaid with Drawdown feature enabled string
Default Quantity The default quantity of units, such as the number of authors in a hosted wiki service. This field is required if you use a per-unit pricing model. number <double>
Deferred Revenue Account The name of the deferred revenue account for this charge. string <= 100 characters
Deferred Revenue Account NS Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Department NS Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Description A description of the charge. string <= 500 characters
Discount Level

Specifies if the discount applies to just the product rate plan, the entire subscription, or any activity in the account.

Enum: "rateplan" "subscription" "account"

string
Drawdown Rate This field is only available if you have the Prepaid with Drawdown feature enabled. The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. number
Drawdown Uom This field is only available if you have the Prepaid with Drawdown feature enabled. Unit of measurement for a drawdown charge. string
End Date Condition

Default: "SubscriptionEnd"

Defines when the charge ends after the charge trigger date.

string
ExcludeItemBillingFromRevenueAccounting

Default: "false"

The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.
This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

boolean
ExcludeItemBookingFromRevenueAccounting

The flag to exclude the related rate plan charges and order line items from revenue accounting.

This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

boolean
Include Children NS

Specifies whether the corresponding item in NetSuite is visible under child subsidiaries. Only available if you have installed the Zuora Connector for NetSuite.

Enum: "Yes" "No"

string
Included Units Specifies the number of units in the base set of units. number <double>
Integration Id NS ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Integration Status NS Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Is Prepaid This field is only available if you have the Prepaid with Drawdown feature enabled. Values: true or false boolean
Is Rollover This field is only available if you have the Prepaid with Drawdown feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed. boolean
Is Stacked Discount This field is only applicable to the Discount - Percentage charge model.For more information, see Stacked discounts. boolean
Item Type NS Type of item that is created in NetSuite for the product rate plan charge. Only available if you have installed the Zuora Connector for NetSuite. Enum: "Inventory" "Non Inventory" "Service" string
IsUnbilled Specifies how to perform the accounting during revenue recognition. The default value is False. Values: True, False This field is available only if you have the Additional Revenue Fields property enabled. boolean
Legacy Revenue Reporting   boolean
List Price Base The list price base for the product rate plan charge. string
Location NS Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Max Quantity Specifies the maximum number of units for this charge. Use this field and the MinQuantity field to create a range of units allowed in a product rate plan charge. Character limit: 16. Values: a positive decimal value number <double>
Min Quantity Specifies the minimum number of units for this charge. Use this field and the MaxQuantity field to create a range of units allowed in a product rate plan charge. Character limit: 16. Values: a positive decimal value number <double>
NumberOfPeriod Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number. integer <int64>
Overage Calculation Option Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored. string
Overage Unused Units Credit Option Determines whether to credit the customer with unused units of usage. string or null
Prepaid OperationType This field is only available if you have the Prepaid with Drawdown feature enabled. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. string
Prepaid Quantity This field is only available if you have the Prepaid with Drawdown feature enabled. The number of units included in a prepayment charge. Must be a positive number. number
Prepaid Total Quantity This field is only available if you have the Prepaid with Drawdown feature enabled. The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge. number
Prepaid Uom This field is only available if you have the Prepaid with Drawdown feature enabled. Unit of measurement for a prepayment charge. string
Price Change Option

Applies an automatic price change when a termed subscription is renewed.

Enum: "NoChange" "SpecificPercentageValue" "UseLatestProductCatalogPricing"

string
Price Increase Option

Applies an automatic price change when a termed subscription is renewed.

Enum: "FromTenantPercentageValue" "SpecificPercentageValue"

string
Price Increase Percentage Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the value to SpecificPercentageValue. Character limit: 16. Values: a decimal value between -100 and 100
 
number or null <double>
ProductCategory This field is used to maintain the product category for integration with Zuora Revenue. string
ProductClass This field is used to maintain the product class for integration with Zuora Revenue. string
ProductFamily This field is used to maintain the product family for integration with Zuora Revenue. string
ProductLine This field is used to maintain the product line for integration with Zuora Revenue. string
Product Rate Plan Charge Number The natural key of the product rate plan charge. string <= 100 characters
RevenueRecognitionTiming This field is only available if you have the Order to Revenue feature enabled. Specifies the type of revenue recognition timing. string <= 200 characters
RevenueAmortizationMethod This field is only available if you have the Order to Revenue feature enabled. Specifies the type of revenue amortization method. string <= 200 characters
Rating Group The name of the recognized revenue account for this charge. string or null
Recognized Revenue Account The name of the recognized revenue account for this charge. string <= 100 characters
RevRecCode Associates this product rate plan charge with a specific revenue recognition code. string or null <= 70 characters
Recognized Revenue Account NS Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Rev Rec End NS End date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string
Rev Rec Start NS Start date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string
Rev Rec Template Type NS Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
RevRec Trigger Condition Specifies when revenue recognition begins. string or null
Revenue Recognition Code Associates this product rate plan charge with a specific revenue recognition code. string or null <= 70 characters
Revenue Recognition Rule Name Determines when to recognize the revenue for this charge. string
Rollover Apply This field is only available if you have the Prepaid with Drawdown feature enabled. This field defines the priority of rollover, which is either first or last. string
Rollover Period Length This field is only available if you have the Prepaid with Drawdown feature enabled. The period length of the rollover fund. If this field is set as optional, you can modify the value. The limit for the value should be 1 which should be less than equal to the specified period which is less than equal to the validity period's length. integer
Rollover Periods This field is only available if you have the Prepaid with Drawdown feature enabled. This field defines the number of rollover periods, it is restricted to 3. number
Smoothing Model Specifies the smoothing model for an overage smoothing charge model. string or null
Specific Billing Period his field is required if you set the value of the BillingPeriod field to Specific Months or Specific Weeks. The valid value is a positive integer. integer or null <int64>
Specific List Price Base The number of months for the list price base of the charge. This field is required if you set the value of the ListPriceBase field to Per Specific Months.This field is available only if you have the Annual List Price feature enabled. integer or null <int32> [ 1 .. 200 ]
Subsidiary NS Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Sync Date NS Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. string <= 255 characters
Tax Code Specifies the tax code for taxation rules. Required when the Taxable field is set to True. string <= 64 characters
Tax Mode Determines how to define taxation for the charge. Required when the Taxable field is set to True. string or null
Taxable Determines whether the charge is taxable. When set to True, the TaxMode and TaxCode fields are required when creating or updating the ProductRatePlanCharge object. boolean
UOM Specifies a configured unit to measure usage. string or null <= 25 characters
Up To Periods Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. integer or null <int64>
Up To Periods Type

Default: "Billing Periods"

The period type used to define when the charge ends.

string or null
Usage Record Rating Option Determines how Zuora processes usage records for per-unit usage charges. string or null
Use Discount Specific Accounting Code    
Use Tenant Default For Price Change

Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal.

Values: true, false

boolean
Validity Period Type This field is only available if you have the Prepaid with Drawdown feature enabled. The period in which the prepayment units are valid to use as defined in a prepayment charge. string
Weekly Bill Cycle Day Specifies which day of the week as the bill cycle day (BCD) for the charge. string
ApplyToBillingPeriodPartially You must enable the Enhanced Discount feature to access this field. boolean
IsNewChargeModelConfigurationConfigurationItem Marker Column TRUE/ FALSE
Charge Model Configuration Item Key* The name of the field that is specified for a specific charge model. string
Charge Model Configuration Item Value* The value of the field that is specified in the Key field. string
Delivery Schedule Frequency The frequency of the delivery. Only supports weekly now string
Delivery Schedule Friday The flag to indicate should the delivery happen on Friday boolean
Delivery Schedule Monday The flag to indicate should the delivery happen on Monday boolean
Delivery Schedule Saturday The flag to indicate should the delivery happen on Saturday boolean
Delivery Schedule Sunday The flag to indicate should the delivery happen on Sunday boolean
Delivery Schedule Thursday The flag to indicate should the delivery happen on Thursday boolean
Delivery Schedule Tuesday The flag to indicate should the delivery happen on Tuesday boolean
Delivery Schedule Wednesday The flag to indicate should the delivery happen on Wendesday boolean
IsNewProductRatePlanChargeTierDataProductRatePlanChargeTier Marker Column TRUE/ FALSE
Tier Data Tier CAP This field is only available for Usage charge type, Tier Pricing Model and Volume Pricing Model number
Tier Data Tier Currency Code The code corresponding to the currency for the tier's price string
Tier Data Tier Discount Amount The specific amount for a fixed discount. Required if the charge model of the product rate plan charge is Discount-Fixed Amount. number <double>
Tier Data Tier Discount Percentage The percentage of discount for a percentage discount. Required if the charge model of the product rate plan charge is Discount-Percentage number <double>
Tier Data Tier Ending Unit The end number of a range of units for the tier. Required if the charge model of the product rate plan charge is Tiered Pricing or Tiered with Overage Pricing. number <double>
Tier Data Tier Is Overage Price Indicates if the price is an overage price, which is the price when usage surpasses the last defined tier. boolean
Tier Data Tier Price 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. number <double>
Tier Data Tier Price Format Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only. string
Tier Data Tier Starting Unit The starting number of a range of units for the tier. Required if the charge model of the product rate plan charge is Tiered Pricing or Tiered with Overage Pricing. number <double>