CRUD: Retrieve a product rate plan charge

The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes.

Specifies the type of charges a specific discount applies to. This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null. All field values are case sensitive and in all-caps.

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

Specifies how to determine the billing day for the charge.

The billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD).

Aligns charges within the same subscription if multiple charges begin on different dates.

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.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Note: This field is only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 141 or higher. Otherwise, an error occurs.

This field defines what type of charge it is:

• Standard: Normal charge with no Prepayment or Commitment or Drawdown.
• Prepayment: For recurring charges. Unit or currency based prepaid charge.
• CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge.
• Drawdown: For usage charges. Drawdown from prepaid funds.
• DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds.
• CreditCommitment: For usage charges. Credit to minimum commitment funds.

Note: This field is only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 133 or higher. Otherwise, an error occurs.

Specifies whether the commitment is measured in units or currency. A prepaid charge can be of type UNIT or CURRENCY. A minimum commitment charge, which is billed in arrears, can only be of type CURRENCY.

For top-up charges, whether recurring or one-time, this field specifies the type of funds created:

• If set to UNIT, the charge creates a fund using the specified prepaidUom.
• If set to CURRENCY, the charge creates a fund based on the currency amount calculated using the list price.

For drawdown (usage) charges, this field specifies the type of funds drawn down from the funds created by top-up charges.

Specifies whether prepaid funds are tracked and consumed at the subscription or account level.

Note: This field is only available if you have the enhanced Unit-Based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Specifies the alignment point used to determine the start of the validity period.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled. Specifies whether to prorate the prepaid units for the validity period.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Specifies the validity period length when a specific validity period is used.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Specifies the unit of time used for the rollover period.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Specifies the priority for rolled-over funds. Lower values are consumed first.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Specifies when rolled-over funds expire.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Indicates whether child accounts can consume drawdown funds from the parent account.

Note: This field is only available if you have the enhanced unit-based Prepaid with Drawdown feature enabled.

To use this field, you must set the X-Zuora-WSDL-Version request header to 155 or higher. Otherwise, an error occurs.

Specifies the priority for drawdown consumption. Lower values are consumed first.

Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration.

Specifies the type of charge.

The automatically generated ID of the Zuora user who created the ProductRatePlanCharge object.

The date when the ProductRatePlanCharge object was created.

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.

Character limit: 16

Values: a valid quantity value.

Note: When ChargeModel is Tiered Pricing or Volume Pricing, if this field is not specified, the value will default to 0.

The name of the deferred revenue account for this charge.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

A description of the charge.

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

Defines when the charge ends after the charge trigger date.

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.

Note: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.

The flag to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.

Notes:

• To use this field, you must set the X-Zuora-WSDL-Version request header to 115 or later. Otherwise, an error occurs.
• This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

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

Notes:

• To use this field, you must set the X-Zuora-WSDL-Version request header to 115 or later. Otherwise, an error occurs.
• This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

Object identifier.

Specifies the number of units in the base set of units.

Character limit: 16

Values: a positive decimal value

The list price base for the product rate plan charge.

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

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

The name of the product rate plan charge.

Specifies the number of periods to use when calculating charges in an overage smoothing charge model. The valid value is a positive whole number.

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.

Determines whether to credit the customer with unused units of usage.

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

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

The ID of the product rate plan associated with this product rate plan charge.

Note: This field is only available if you have the Charge Level Proration feature enabled. For more information, see <a href="https://docs.zuora.com?resourceId=billing-usage-charge-proration" target="_blank">Usage charge proration</a> and <a href="https://docs.zuora.com?resourceId=billing-charge-level-proration-option-for-a-recurring-charge" target="_blank">Charge level proration option for a recurring charge</a>.

To use this field, you must set the X-Zuora-WSDL-Version request header to 135 or higher. Otherwise, an error occurs.

You can use this field to specify the charge-level proration option for a usage charge or recurring charge. The tenant-level proration option will be overridden.

• NoProration: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
• TimeBasedProration: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
• DefaultFromTenantSetting: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
• ChargeFullPeriod: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.

A rating group based on which usage records are rated. Only applicable to Usage charges.

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.

For more information, see Usage rating by group.

The name of the recognized revenue account for this charge.

• Required when the Allow Blank Accounting Code setting is No.
• Optional when the Allow Blank Accounting Code setting is Yes.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Associates this product rate plan charge with a specific revenue recognition code.

Specifies when revenue recognition begins.

Determines when to recognize the revenue for this charge.

Specifies the smoothing model for an overage smoothing charge model.

Customizes the number of months or weeks for the charges billing period. 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.

The number of months for the list price base of the charge. The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months.

Notes:

• This field is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-annual-list-price" target="_blank">Annual List Price</a> feature enabled.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 129 or later. Otherwise, an error occurs.
• The value of this field is null if you do not set the value of the ListPriceBase field to Per Specific Months.

Specifies the tax code for taxation rules. Required when the Taxable field is set to True.

Note: This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge.

Determines how to define taxation for the charge. Required when the Taxable field is set to True.

Note: This value affects the tax calculation of rate plan charges that come from the ProductRatePlanCharge.

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.

Specifies when to start billing the customer for the charge.

Values:

• ContractEffective is the date when the subscription's contract goes into effect and the charge is ready to be billed.
• ServiceActivation is the date when the services or products for a subscription have been activated and the customers have access.
• CustomerAcceptance is when the customer accepts the services or products for a subscription.

Specifies the units to measure usage.

Note: You must specify this field when creating the following charge models:

• Per Unit Pricing
• Volume Pricin
• Overage Pricing
• Tiered Pricing
• Tiered with Overage Pricing

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.

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.

The ID of the last user to update the object.

The date when the object was last updated.

Determines whether to define a new accounting code for the new discount charge.

Character limit: 5

Values: True, False

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

Character limit: 5

Values: true, false

Specifies which day of the week as the bill cycle day (BCD) for the charge.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is False.

Values: True, False

Notes:

• The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

Specifies how to perform the accounting during revenue recognition. The default value is False.

Values: True, False

Notes:

• The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

This field is used to maintain the product category for integration with Zuora Revenue.

Notes:

• This field is available only if you have the Additional Revenue Fields property enabled.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

This field is used to maintain the product class for integration with Zuora Revenue.

Notes:

• This field is available only if you have the Additional Revenue Fields property enabled.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

This field is used to maintain the product family for integration with Zuora Revenue.

Notes:

• This field is available only if you have the Additional Revenue Fields property enabled.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

This field is used to maintain the product line for integration with Zuora Revenue.

Notes:

• This field is available only if you have the Additional Revenue Fields property enabled.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 132 or later.

When you apply percentage discounts to either of the following charges, you need to set the ReflectDiscountInNetAmount field on your discount charge to true, to enable calculating and displaying the net amount of the following charges in Zuora Revenue.

• delivery pricing charge
• prepayment charge
• drawdown charge

Note the following:

• If you are an <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> customer, when you set the ReflectDiscountInNetAmount field to true, you must also set both the ExcludeItemBookingFromRevenueAccounting and ExcludeItemBillingFromRevenueAccounting fields to true.
• If you are a <a href="https://docs.zuora.com?resourceId=revenue-billing-integration" target="_blank">Billing - Revenue Integration</a> customer, you must set the ReflectDiscountInNetAmount field to false, otherwise an error will be returned. Billing - Revenue Integration customers are not supported with net amount.
• If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the ReflectDiscountInNetAmount field to true.

Specifies the type of revenue recognition timing.

Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href="https://docs.zuora.com?resourceId=billing-configure-revenue-settings" target="_blank">revenue recognition policy configuration</a> in the Zuora Billing UI.

Note: This field is only available if you have the Order to Revenue feature enabled.

Specifies the type of revenue amortization method.

Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href="https://docs.zuora.com?resourceId=billing-configure-revenue-settings" target="_blank">revenue recognition policy configuration</a> in the Zuora Billing UI.

Note: This field is only available if you have the Order to Revenue feature enabled.

Allow the discount duration to be aligned with the billing period partially.

Note: You must enable the Enhanced Discount feature to access this field.

The price lookup formula defined for the product rate plan charge, which is used to identify the correct and relevant charge definition based on the context.

For more information, see <a href="https://docs.zuora.com?resourceId=billing-price-lookup-in-attribute-based-pricing" target="_blank">Price lookup in Attribute-based Pricing</a>.

Notes:

• This field is available only if the <a href="https://docs.zuora.com?resourceId=billing-attribute-based-pricing" target="_blank">Attribute-based Pricing</a> feature is enabled.
• To use this field, you must set the X-Zuora-WSDL-Version request header to 138 or higher.

Class associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Deferrred revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Department associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

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

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Status of the product rate plan charge's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

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.

Location associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Recognized revenue account associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

End date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Start date condition of the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Only available if you have installed the Zuora Connector for NetSuite.

Subsidiary associated with the corresponding item in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Date when the product rate plan charge was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.