Create 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.
Object | Field Name | Value | Required to create | Description |
---|---|---|---|---|
ProductRatePlanCharge | IsNewProductRatePlanCharge | TRUE or FALSE | Required when creating new charge ,Enter the value as 'True' if applicable; otherwise the value as FALSE,the cell can be left blank | Indicator Column marking the start of a new object |
ProductRatePlanCharge | Bill Cycle Type* | STRING | Required to Create | Specifies how to determine the billing day for the charge, Enum: "DefaultFromCustomer" "SpecificDayofMonth" "SubscriptionStartDay" "ChargeTriggerDay" "SpecificDayofWeek" "TermStartDay" "TermEndDay" |
ProductRatePlanCharge | Billing Period* | STRING | Required to Create | The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). Enum: "Month" "Quarter" "Annual" "Semi-Annual" "Specific Months" "Subscription Term" "Week" "Specific Weeks" "Specific Days" |
ProductRatePlanCharge | Charge Model* | STRING | Required to Create | Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration. Enum: "Discount-Fixed Amount" "Discount-Percentage" "Flat Fee Pricing" "Per Unit Pricing" "Overage Pricing" "Tiered Pricing" "Tiered with Overage Pricing" "Volume Pricing" "Delivery Pricing" "MultiAttributePricing" "PreratedPerUnit" "PreratedPricing`" "HighWatermarkVolumePricing" "HighWatermarkTieredPricing" |
ProductRatePlanCharge | Charge Type* | STRING | Required to Create | Specifies the type of charge Enum: "OneTime" "Recurring" "Usage" |
ProductRatePlanCharge | Name* | STRING <= 100 characters | Required to Create | The name of the product rate plan charge. |
ProductRatePlanCharge | Product Rate Plan Id* | STRING <= 32 characters | Required to Create | The ID of the product rate plan associated with this product rate plan charge. |
ProductRatePlanCharge | Trigger Event* | STRING | Required to Create | Specifies when to start billing the customer for the charge |
ProductRatePlanCharge | UseDiscountSpecificAccountingCode* | boolean or null | Required to Create | Determines whether to define a new accounting code for the new discount charge. Character limit: 5 Values: True, False |
ProductRatePlanCharge | Accounting Code | STRING <= 100 characters | Optional | The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. |
ProductRatePlanCharge | Apply Discount To | STRING | Optional | 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)" |
ProductRatePlanCharge | BillCycleDay | integer <int32> | Optional | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month 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 |
ProductRatePlanCharge | Billing Period Alignment | STRING | Optional | Aligns charges within the same subscription if multiple charges begin on different dates Note: The AlignToTermEnd value is only available for prepayment charges by default. Reach out to Zuora Global Support to enable it for non-prepaid recurring charges. Enum: "AlignToCharge" "AlignToSubscriptionStart" "AlignToTermStart" "AlignToTermEnd" |
ProductRatePlanCharge | Billing Timing | STRING | Optional | The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types. Enum: "In Advance" "In Arrears" |
ProductRatePlanCharge | ChargeFunction | STRING | Optional | This field is only available if you have the Unbilled Usage feature enabled. Enum: "Standard" "Prepayment" "CommitmentTrueUp" "Drawdown" "CreditCommitment" "DrawdownAndCreditCommitment" |
ProductRatePlanCharge | CommitmentType | STRING | Optional | This field is only available if you have the Unbilled Usage feature enabled. Enum: "UNIT" "CURRENCY" |
ProductRatePlanCharge | Class NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Credit Option | STRING | Optional | This field is only available if you have the Prepaid with Drawdown feature enabled Enum: "TimeBased" "ConsumptionBased" "FullCreditBack" |
ProductRatePlanCharge | Default Quantity | number <double> | Requiredif using a per-unit pricing model. | The default quantity of units, such as the number of authors in a hosted wiki service. Enum: "TimeBased" "ConsumptionBased" "FullCreditBack" Character limit: 16 Values: a valid quantity value. Note: When the ChargeModel field is set to Tiered Pricing or Volume Pricing, if this field is not specified, the value will default to 0. |
ProductRatePlanCharge | Deferred Revenue Account | STRING <= 100 characters | Optional | The name of the deferred revenue account for this charge. |
ProductRatePlanCharge | Deferred Revenue Account NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Department NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Description | STRING <= 500 characters | Optional | A description of the charge. |
ProductRatePlanCharge | Discount Level | STRING | Optional | Specifies if the discount applies to just the product rate plan, the entire subscription, or to any activity in the account.Enum: "rateplan" "subscription" "account" Enum: "rateplan" "subscription" "account" |
ProductRatePlanCharge | Drawdown Rate | number | Optional | 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. |
ProductRatePlanCharge | Drawdown Uom | STRING | Optional | This field is only available if you have the Prepaid with Drawdown feature enabled. Unit of measurement for a drawdown charge. |
ProductRatePlanCharge | End Date Condition | STRING | Optional | Default: "SubscriptionEnd" Defines when the charge ends after the charge trigger date. Enum: "SubscriptionEnd" "FixedPeriod" Values: SubscriptionEnd: The charge ends on the subscription end date after a specified period based on the trigger date of the charge. FixedPeriod: The charge ends after a specified period based on the trigger date of the charge. If you set this field to FixedPeriod, you must specify the length of the period and a period type by defining the UpToPeriods and UpToPeriodsType fields. |
ProductRatePlanCharge | ExcludeItemBillingFromRevenueAccounting | boolean | Optional | Default: falseThe 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. |
ProductRatePlanCharge | ExcludeItemBookingFromRevenueAccounting | boolean | Optional | Default: false 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. |
ProductRatePlanCharge | Include Children NS | STRING | Optional, Applicable with Netsuite Integration | 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" |
ProductRatePlanCharge | Included Units | number <double> | Optional | Specifies the number of units in the base set of units. Character limit: 16 Values: a positive decimal value |
ProductRatePlanCharge | Integration Id NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Integration Status NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Is Prepaid | boolean | Optional | This field is only available if you have the Prepaid with Drawdown feature enabled.Values: true or false |
ProductRatePlanCharge | Is Rollover | boolean | Optional | 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. |
ProductRatePlanCharge | Is Stacked Discount | boolean | Optional | This field is only applicable to the Discount - Percentage charge model.For more information, see Stacked discounts. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: True: This is a stacked discount, which should be calculated by stacking with other discounts. False: This is not a stacked discount, which should be calculated in sequence with other discounts. |
ProductRatePlanCharge | Item Type NS | STRING | Optional, Applicable with Netsuite Integration | 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" |
ProductRatePlanCharge | IsUnbilled | boolean | Optional | 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. |
ProductRatePlanCharge | Legacy Revenue Reporting | boolean | Optional | |
ProductRatePlanCharge | List Price Base | STRING | Optional | The list price base for the product rate plan charge. Enum: "Per Billing Period" "Per Month" "Per Week" "Per Year" "Per Specific Months" |
ProductRatePlanCharge | Location NS | STRING <= 255 characters | Optional | Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Max Quantity | number <double> | Optional | 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 |
ProductRatePlanCharge | Min Quantity | number <double> | Optional | 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 |
ProductRatePlanCharge | NumberOfPeriod | integer <int64> | Optional | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number. |
ProductRatePlanCharge | Overage Calculation Option | STRING | Optional | Determines when to calculate overage charges. If the value of the SmoothingMode field is not specified, the value of this field is ignored. Values: EndOfSmoothingPeriod: This option is used by default. The overage is charged at the end of the smoothing period. PerBillingPeriod: The overage is charged on-demand rather than waiting until the end of the smoothing period. Enum: "EndOfSmoothingPeriod" "PerBillingPeriod" |
ProductRatePlanCharge | Overage Unused Units Credit Option | STRING or null | Optional | Determines whether to credit the customer with unused units of usage. Enum: "NoCredit" "CreditBySpecificRate" null |
ProductRatePlanCharge | Prepaid OperationType | STRING | Optional | 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. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. Enum: "topup" "drawdown" |
ProductRatePlanCharge | Prepaid Quantity | number | Optional | 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. |
ProductRatePlanCharge | Prepaid Total Quantity | number | Optional | 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. |
ProductRatePlanCharge | Prepaid Uom | STRING | Optional | This field is only available if you have the Prepaid with Drawdown feature enabled. Unit of measurement for a prepayment charge. |
ProductRatePlanCharge | Price Change Option | STRING | Optional | Applies an automatic price change when a termed subscription is renewed. Enum: "NoChange" "SpecificPercentageValue" "UseLatestProductCatalogPricing" |
ProductRatePlanCharge | Price Increase Option | STRING | Optional | Applies an automatic price change when a termed subscription is renewed.Enum: "FromTenantPercentageValue" "SpecificPercentageValue" |
ProductRatePlanCharge | Price Increase Percentage | number or null <double> | Optional | 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 |
ProductRatePlanCharge | ProductCategory | STRING | Optional | This field is used to maintain the product category for integration with Zuora Revenue. This field is available only if you have the Additional Revenue Fields property enabled. |
ProductRatePlanCharge | ProductClass | STRING | Optional | This field is used to maintain the product class for integration with Zuora Revenue. This field is available only if you have the Additional Revenue Fields property enabled. |
ProductRatePlanCharge | ProductFamily | STRING | Optional | This field is used to maintain the product family for integration with Zuora Revenue. This field is available only if you have the Additional Revenue Fields property enabled. |
ProductRatePlanCharge | ProductLine | STRING | Optional | This field is used to maintain the product line for integration with Zuora Revenue. This field is available only if you have the Additional Revenue Fields property enabled. |
ProductRatePlanCharge | Product Rate Plan Charge Number | STRING <= 100 characters | Optional | The natural key of the product rate plan charge. |
ProductRatePlanCharge | RevenueRecognitionTiming | STRING <= 200 characters | Optional | This field is only available if you have the Order to Revenue feature enabled.Specifies the type of revenue recognition timing. Note: This field is only available if you have the Order to Revenue feature enabled. Enum: "Upon Billing Document Posting Date" "Upon Order Activation Date" |
ProductRatePlanCharge | RevenueAmortizationMethod | STRING <= 200 characters | Optional | This field is only available if you have the Order to Revenue feature enabled. Specifies the type of revenue amortization method. This field is only available if you have the Order to Revenue feature enabled. Enum: "Immediate" "Ratable Using Start And End Dates" |
ProductRatePlanCharge | Rating Group | STRING or null | Optional | The name of the recognized revenue account for this charge. Possible values: ByBillingPeriod: The rating is based on all the usages in a billing period. ByUsageStartDate: The rating is based on all the usages on the same usage start date. ByUsageRecord: The rating is based on each usage record. ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). ByGroupId: The rating is based on all the usages in a custom group. Notes: The ByBillingPeriod value can be applied for all charge models. The ByUsageStartDate, ByUsageRecord, and ByUsageUpload values can only be applied for per unit, volume pricing, and tiered pricing charge models. The ByGroupId value is only available if you have the Active Rating feature enabled. Use this field only for Usage charges. One-Time Charges and Recurring Charges return NULL. Enum: "ByBillingPeriod" "ByUsageStartDate" "ByUsageRecord" "ByUsageUpload" "ByGroupId" null |
ProductRatePlanCharge | Recognized Revenue Account | STRING <= 100 characters | Optional | The name of the recognized revenue account for this charge. |
ProductRatePlanCharge | RevRecCode | STRING or null <= 70 characters | Optional | Associates this product rate plan charge with a specific revenue recognition code. |
ProductRatePlanCharge | Recognized Revenue Account NS | STRING <= 255 characters | Optional | Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Rev Rec End NS | STRING | Optional, Applicable with Netsuite Integration | End date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Rev Rec Start NS | STRING | Optional, Applicable with Netsuite Integration | Start date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Rev Rec Template Type NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | RevRec Trigger Condition | STRING or null | Optional | Specifies when revenue recognition begins. Enum: "ContractEffectiveDate" "ServiceActivationDate" "CustomerAcceptanceDate" null |
ProductRatePlanCharge | Revenue Recognition Code | STRING or null <= 70 characters | Optional | Associates this product rate plan charge with a specific revenue recognition code. |
ProductRatePlanCharge | Revenue Recognition Rule Name | STRING | Optional | Determines when to recognize the revenue for this charge. Enum: "Recognize upon invoicing" "Recognize daily over time" |
ProductRatePlanCharge | Rollover Apply | STRING | Optional | 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. Enum: "ApplyFirst" "ApplyLast" |
ProductRatePlanCharge | Rollover Period Length | integer | Optional | 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, then you can modify the value. The limit for the value should be 1 which should be lesser than equal to the specified period that is lesser than equal to the validity period's length. |
ProductRatePlanCharge | Rollover Periods | number | Optional | 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. |
ProductRatePlanCharge | Smoothing Model | STRING or null | Optional | Specifies the smoothing model for an overage smoothing charge model. Enum: "RollingWindow" "Rollover" null |
ProductRatePlanCharge | Specific Billing Period | integer or null <int64> | Required if the Billing Period value is set to specific months or specific weeks | This 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. |
ProductRatePlanCharge | Specific List Price Base | integer or null <int32> [ 1 .. 200 ] | Required if ListPriceBase is set to specific months | 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. This field is available only if you have the Annual List Price feature enabled. The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months. |
ProductRatePlanCharge | Subsidiary NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Sync Date NS | STRING <= 255 characters | Optional, Applicable with Netsuite Integration | Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. |
ProductRatePlanCharge | Tax Code | STRING <= 64 characters | Required when Taxable field is set to true | Specifies the tax code for taxation rules. Required when the Taxable field is set to True. This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge |
ProductRatePlanCharge | Tax Mode | STRING or null | Required when Taxable field is set to true | Determines how to define taxation for the charge. Required when the Taxable field is set to True. This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge. Enum: "TaxExclusive" "TaxInclusive" null |
ProductRatePlanCharge | Taxable | boolean | Required when Taxable field is set to true | Determines whether the charge is taxable. When set to True, the TaxMode and TaxCode fields are required when creating or updating th ProductRatePlanCharge object. Character limit: 5 Values: True, False Note: This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge. |
ProductRatePlanCharge | UOM | STRING or null <= 25 characters | Optional | Specifies a configured unit to measure usage. You must specify this field when creating the following charge models: Per Unit Pricing Volume Pricing Overage Pricing Tiered Pricing Tiered with Overage Pricing |
ProductRatePlanCharge | Up To Periods | integer or null <int64> | Optional | 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. Character limit: 5 Values: a whole number between 0 and 65535, exclusive Notes: You must use this field together with the UpToPeriodsType field to specify the time period. This field is applicable only when the EndDateCondition field is set to FixedPeriod. If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. |
ProductRatePlanCharge | Up To Periods Type | STRING or null | Optional | Default: "Billing Periods" The period type used to define when the charge ends. Notes: You must use this field together with the UpToPeriods field to specify the time period. This field is applicable only when the EndDateCondition field is set to FixedPeriod. Enum: "Billing Periods" "Days" "Weeks" "Months" "Years" null |
ProductRatePlanCharge | Usage Record Rating Option | STRING or null | Optional | Determines how Zuora processes usage records for per-unit usage charges. Enum: "EndOfBillingPeriod" "OnDemand" null |
ProductRatePlanCharge | Use Tenant Default For Price Change | boolean | Optional | Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. Values: true, false Character limit: 5 |
ProductRatePlanCharge | Validity Period Type | STRING | Optional | 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. The period in which the prepayment units are valid to use as defined in a prepayment charge. Enum: "SUBSCRIPTION_TERM" "ANNUAL" "SEMI_ANNUAL" "QUARTER" "MONTH" |
ProductRatePlanCharge | Weekly Bill Cycle Day | STRING | Optional | Specifies which day of the week as the bill cycle day (BCD) for the charge. Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" |
ProductRatePlanCharge | ApplyToBillingPeriodPartially | boolean | Optional | ou must enable the Enhanced Discount feature to access this field. |
ProductRatePlanCharge>ChargeModelConfigurationdata | IsNewChargeModelConfigurationConfigurationItem | TRUE or FALSE | Required when creating new Pre-rated or Multi-attribute pricing charge model ,Enter the value as 'True' if applicable; otherwise the value as FALSE,the cell can be left blank | Indicator Column marking the start of a new object. Container for charge model configuration data. Notes: This field is only available if you have the Pre-Rated Pricing or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information. |
ProductRatePlanCharge>ChargeModelConfigurationdata | Charge Model Configuration Item Key* | STRING | Required to Create when creating pre-rates or Multi-attribute pricing charge model | The name of the field that is specified for a specific charge model. Configuration keys supported are as follows: formula (only available if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.) customFieldPerUnitRate (only available if you have the Pre-Rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.) customFieldTotalAmount (only available if you have the Pre-Rated Pricing model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.) |
ProductRatePlanCharge>ChargeModelConfigurationdata | Charge Model Configuration Item Value* | STRING | Required to Create when creating pre-rates or Multi-attribute pricing charge model | The value of the field that is specified in the Key field. Possible values are follows: A valid pricing formula to calculate actual rating amount for each usage record. For example, usageQuantity()*10. Use it with Key formula when the Multi-Attribute Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information. A name of a usage custom field that carries the per-unit rate for a usage record. For example, perUnitRate__c. Use it with Key customFieldPerUnitRate when the Pre-Rated Per Unit Pricing charge model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information. A name of a usage custom field that carries the total amount for a usage record. For example, totalAmount__c. Use it with Key customFieldTotalAmount when the Pre-Rated Pricing model is used. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information. |
Delivery Schedule | Delivery Schedule Frequency | STRING | Optional | The frequency of the delivery. Only supports weekly now |
Delivery Schedule | Delivery Schedule Friday | boolean | Optional | The flag to indicate should the delivery happen on Friday |
Delivery Schedule | Delivery Schedule Monday | boolean | Optional | The flag to indicate should the delivery happen on Monday |
Delivery Schedule | Delivery Schedule Saturday | boolean | Optional | The flag to indicate should the delivery happen on Saturday |
Delivery Schedule | Delivery Schedule Sunday | boolean | Optional | The flag to indicate should the delivery happen on Sunday |
Delivery Schedule | Delivery Schedule Thursday | boolean | Optional | The flag to indicate should the delivery happen on Thursday |
Delivery Schedule | Delivery Schedule Tuesday | boolean | Optional | The flag to indicate should the delivery happen on Tuesday |
Delivery Schedule | Delivery Schedule Wednesday | boolean | Optional | The flag to indicate should the delivery happen on Wendesday |
object (productRatePlanChargeTierData) | IsNewProductRatePlanChargeTierDataProductRatePlanChargeTier | TRUE or FALSE | Required when creating new charge tier ,Enter the value as 'True' if applicable; otherwise the value as FALSE,the cell can be left blank | Indicator Column marking the start of a new object. Array of product rate plan charge tiers. You should specify all relevant fields of all tiers, including pricing information for each currency. For each currency, ensure that the tiers appear in ascending order of StartingUnit. For more details, click here. |
ProductRatePlanCharge>Tier | Tier Data Tier CAP | number | Optional | This field is only avaialble for Usage charge type, Tier Pricing Model and Volume Pricing Model |
ProductRatePlanCharge>Tier | Tier Data Tier Currency Code | STRING | Optional | The code corresponding to the currency for the tier's price |
ProductRatePlanCharge>Tier | Tier Data Tier Discount Amount | number <double> | Required if the charge model of the product rate plan charge is Discount-Fixed Amount | The specific amount for a fixed discount. Required if the charge model of the product rate plan charge is Discount-Fixed Amount. |
ProductRatePlanCharge>Tier | Tier Data Tier Discount Percentage | number <double> | Required if the charge model of the product rate plan charge is Discount-Percentage Amount | The percentage of discount for a percentage discount. Required if the charge model of the product rate plan charge is Discount-Percentage |
ProductRatePlanCharge>Tier | Tier Data Tier Ending Unit | number <double> | Required if the charge model of the product rate plan charge is Tiered Pricing or Tiered Overage | 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. |
ProductRatePlanCharge>Tier | Tier Data Tier Is Overage Price | boolean | Optional | Indicates if the price is an overage price, which is the price when usage surpasses the last defined tier. |
ProductRatePlanCharge>Tier | Tier Data Tier Price | number <double> | Optional | 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. |
ProductRatePlanCharge>Tier | Tier Data Tier Price Format | STRING | Optional | Indicates if pricing is a flat fee or is per unit. This field is for tiered and volume pricing models only. |
ProductRatePlanCharge>Tier | Tier Data Tier Starting Unit | number <double> | Required if the charge model of the product rate plan charge is Tiered Pricing or Tiered Overage | 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. |