Sign in
Product Rate Plan Charges

CRUD: Create a product rate plan charge

Creates a product rate plan charge for a specified rate plan charge. Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees.

Note: To use the enhanced unit-based Prepaid with Drawdown fields, set the X-Zuora-WSDL-Version request header to a value greater than 155.0.

post/v1/object/product-rate-plan-charge

Query parameters

rejectUnknownFieldsboolean

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

X-Zuora-WSDL-Versionstring

Zuora WSDL version number.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

AccountingCodestring

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

ApplyDiscountTo'ONETIME (1)' | 'RECURRING (2)' | 'USAGE (4)' | 'ONETIMERECURRING (3)' | 'ONETIMEUSAGE (5)' | 'RECURRINGUSAGE (6)' | 'ONETIMERECURRINGUSAGE (7)'

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

BillCycleDayinteger

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

BillCycleType'DefaultFromCustomer' | 'SpecificDayofMonth' | 'SubscriptionStartDay' | 'ChargeTriggerDay' | 'SpecificDayofWeek' | 'TermStartDay' | 'TermEndDay' required

Specifies how to determine the billing day for the charge.

Notes:

  • If you set this field to SpecificDayofMonth, you must specify which day of the month as the billing day for the charge in the BillCycleDay field.
  • If you set this field to SpecificDayofWeek, you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field.
  • By default, TermStartDay and TermEndDay are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:
    • The Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field.
    • For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field.
    • For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values.
BillingPeriod'Month' | 'Quarter' | 'Annual' | 'Semi-Annual' | 'Specific Months' | 'Subscription Term' | 'Week' | 'Specific Weeks' | 'Specific Days' required

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

Notes:

  • Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to Specific Months or Specific Weeks.
  • The Subscription Term value is in Limited Availability.
BillingPeriodAlignment'AlignToCharge' | 'AlignToSubscriptionStart' | 'AlignToTermStart' | 'AlignToTermEnd'

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.

BillingTiming'In Advance' | 'In Arrears'

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.

ChargeFunction'Standard' | 'Prepayment' | 'CommitmentTrueUp' | 'Drawdown' | 'CreditCommitment' | 'DrawdownAndCreditCommitment'

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.
PrepaymentUnitType'UNIT' | 'CURRENCY'

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.

DrawdownScope'SUBSCRIPTION' | 'ACCOUNT'

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.

ValidityPeriodAlignment'ChargeStart' | 'TermStart' | 'TermEnd'

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

VP alignment mode.

ValidityPeriodProrationOption'ProrateUnits' | 'NoProrate'

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

VP proration option.

SpecificValidityPeriodLengthinteger

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

Validity period length.

RolloverPeriodType'Day' | 'Month' | 'Quarter' | 'Annual'

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

Rollover period type.

RolloverFundPriorityinteger

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

Priority for rolled-over funds; lower value consumed first.

RolloverEndDateType'ChargeEndDate' | 'SubscriptionTerm'

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

Rollover end date type.

FundSupportAccountHierarchyboolean

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

Enable sub-account drawdown from parent's funds.

DrawdownPriorityinteger

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

Priority for drawdown consumption; lower value consumed first.

ChargeModel'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' required

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

Notes:

  • The Delivery Pricing value is available only if you have the Delivery Pricing charge model enabled. The minimal required WSDL version is 128.
  • The MultiAttributePricing value is available only 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. The minimal required WSDL version is 102.
  • The PreratedPerUnit and value is available only 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. The minimal required WSDL version is 102.
  • The PreratedPricing value is available only if you have the Pre-rated 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. The minimal required WSDL version is 102.
  • The HighWatermarkVolumePricingvalue is available only if you have the High Water Mark Volume 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. The minimal required WSDL version is 102.
  • The HighWatermarkTieredPricing value is available only if you have the High Water Mark Tiered 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. The minimal required WSDL version is 102.
ChargeType'OneTime' | 'Recurring' | 'Usage' required

Specifies the type of charge.

CreditOption'TimeBased' | 'ConsumptionBased' | 'FullCreditBack'

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

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

The way to calculate credit. See Credit Option for more information.

DefaultQuantitynumber double

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 the ChargeModel field is set to Tiered Pricing or Volume Pricing, if this field is not specified, the value will default to 0.

DeferredRevenueAccountstring

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.

Descriptionstring

A description of the charge.

DiscountLevel'rateplan' | 'subscription' | 'account'

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

DrawdownRatenumber

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

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

The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. See Fields related to Prepaid with Drawdown for more information.

DrawdownUomstring

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

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

Unit of measurement for a drawdown charge.

EndDateCondition'SubscriptionEnd' | 'FixedPeriod'

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.

ExcludeItemBillingFromRevenueAccountingboolean

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.
ExcludeItemBookingFromRevenueAccountingboolean

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.
IncludedUnitsnumber double

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

Character limit: 16

Values: a positive decimal value

IsAllocationEligibleboolean

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.
IsPrepaidboolean

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

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

Indicates whether this charge is a prepayment (topup) charge or a drawdown charge.

Values: true or false.

IsRolloverboolean

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

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

The value is either "True" or "False". It determines whether the rollover fields are needed.

IsStackedDiscountboolean

Note: This field is only applicable to the Discount - Percentage charge model.

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

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.

For more information, see Stacked discounts.

IsUnbilledboolean

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.
LegacyRevenueReportingboolean
ListPriceBase'Per Billing Period' | 'Per Month' | 'Per Week' | 'Per Year' | 'Per Specific Months'

The list price base for the product rate plan charge.

Note: If the ListBasePrice field is not set in the request, the system will use the BillingPeriod value as the default value.

MaxQuantitynumber double

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

MinQuantitynumber double

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

Namestring required

The name of the product rate plan charge.

NumberOfPeriodinteger

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

OverageCalculationOption'EndOfSmoothingPeriod' | 'PerBillingPeriod'

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.
OverageUnusedUnitsCreditOption'NoCredit' | 'CreditBySpecificRate' | 'null' nullable

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

PrepaidOperationType'topup' | 'drawdown'

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

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

The type of this charge. It is either a prepayment (topup) charge or a drawdown charge.

PrepaidQuantitynumber

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

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

The number of units included in a prepayment charge. Must be a positive number.

PrepaidTotalQuantitynumber

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

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

The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge.

PrepaidUomstring

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

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

Unit of measurement for a prepayment charge.

PriceChangeOption'NoChange' | 'SpecificPercentageValue' | 'UseLatestProductCatalogPricing'

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

PriceIncreaseOption'FromTenantPercentageValue' | 'SpecificPercentageValue'

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

PriceIncreasePercentagenumber double nullable

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

ProductCategorystring

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.
ProductClassstring

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.
ProductFamilystring

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.
ProductLinestring

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.
ReflectDiscountInNetAmountboolean

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 does not support discounts on the preceding charges.
  • 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.
RevenueRecognitionTiming'Upon Billing Document Posting Date' | 'Upon Order Activation Date'

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.

RevenueAmortizationMethod'Immediate' | 'Ratable Using Start And End Dates'

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.

ProductRatePlanChargeNumberstring

The natural key of the product rate plan charge.

Values:

  • leave null for automatically generated string
  • an alphanumeric string of 100 characters or fewer

Note: This field is only available if you set the X-Zuora-WSDL-Version request header to 133 or later.

ProductRatePlanIdstring required

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

ProrationOption'NoProration' | 'TimeBasedProration' | 'DefaultFromTenantSetting' | 'ChargeFullPeriod'

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.
RatingGroup'ByBillingPeriod' | 'ByUsageStartDate' | 'ByUsageRecord' | 'ByUsageUpload' | 'ByGroupId' | 'null' nullable

Specifies a rating group based on which usage records are rated.

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.
RecognizedRevenueAccountstring

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.

RevRecCodestring nullable

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

RevRecTriggerCondition'ContractEffectiveDate' | 'ServiceActivationDate' | 'CustomerAcceptanceDate' | 'null' nullable

Specifies when revenue recognition begins.

RevenueRecognitionRuleName'Recognize upon invoicing' | 'Recognize daily over time'

Determines when to recognize the revenue for this charge.

RolloverApply'ApplyFirst' | 'ApplyLast'

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

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

This field defines the priority of rollover, which is either first or last.

RolloverPeriodsnumber

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

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

This field defines the number of rollover periods, it is restricted to 3.

SmoothingModel'RollingWindow' | 'Rollover' | 'null' nullable

Specifies the smoothing model for an overage smoothing charge model.

SpecificBillingPeriodinteger nullable

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.

SpecificListPriceBaseinteger nullable

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. The value must be a positive integer between 1 and 120 inclusive.

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.
TaxCodestring

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.

TaxMode'TaxExclusive' | 'TaxInclusive' | 'null' nullable

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.

Taxableboolean

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.

TriggerEvent'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' required

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.
UOMstring nullable

Specifies a configured unit to measure usage.

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

  • Per Unit Pricing
  • Volume Pricing
  • Overage Pricing
  • Tiered Pricing
  • Tiered with Overage Pricing
UpToPeriodsinteger nullable

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.
UpToPeriodsType'Billing Periods' | 'Days' | 'Weeks' | 'Months' | 'Years' | 'null' nullable

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.
UsageRecordRatingOption'EndOfBillingPeriod' | 'OnDemand' | 'null' nullable

Determines how Zuora processes usage records for per-unit usage charges.

UseDiscountSpecificAccountingCodeboolean nullable required

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

Character limit: 5

Values: True, False

UseTenantDefaultForPriceChangeboolean

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

Character limit: 5

Values: true, false

ValidityPeriodType'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' | 'SPECIFIC_DAYS' | 'SPECIFIC_WEEKS' | 'SPECIFIC_MONTHS'

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

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

The period in which the prepayment units are valid to use as defined in a prepayment charge.

WeeklyBillCycleDay'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday'

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.

ApplyToBillingPeriodPartiallyboolean

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

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

RolloverPeriodLengthinteger

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

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

Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the rolloverPeriods field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year.

Formulastring

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__NSstring

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

DeferredRevAccount__NSstring

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

Department__NSstring

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

IncludeChildren__NS'Yes' | 'No'

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

IntegrationId__NSstring

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

IntegrationStatus__NSstring

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

ItemType__NS'Inventory' | 'Non Inventory' | 'Service'

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__NSstring

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

RecognizedRevAccount__NSstring

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

RevRecEnd__NS'Charge Period Start' | 'Rev Rec Trigger Date' | 'Use NetSuite Rev Rec Template'

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

RevRecStart__NS'Charge Period Start' | 'Rev Rec Trigger Date' | 'Use NetSuite Rev Rec Template'

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

RevRecTemplateType__NSstring

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

Subsidiary__NSstring

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

SyncDate__NSstring

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

Example request

{
  "Name": "One-Time charge",
  "ProductRatePlanId": "8ad08ae290c4bb470190dedf752745af",
  "ChargeType": "OneTime",
  "ChargeModel": "Flat Fee Pricing",
  "ProductRatePlanChargeTierData": {
    "ProductRatePlanChargeTier": [
      {
        "Price": 10
      }
    ]
  },
  "TriggerEvent": "ContractEffective"
}

Response

OK

Idstring
Successboolean

Changes

Changed in 1 of the 4 revisions of this API.1114

  • 7f43d4a77e8a1114See the full diff
    • ▲

      removed the enum value PreratedPricing of the request property allOf[subschema #1]/ChargeModel

      request-property-enum-value-removed

    • ●

      removed the request property allOf[subschema #1]/CommitmentType

      request-property-removed

    • ○

      added the new optional request property allOf[subschema #1]/DrawdownPriority

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/DrawdownScope

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/FundSupportAccountHierarchy

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/PrepaymentUnitType

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/RolloverEndDateType

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/RolloverFundPriority

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/RolloverPeriodType

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/SpecificValidityPeriodLength

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/ValidityPeriodAlignment

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #1]/ValidityPeriodProrationOption

      new-optional-request-property

    • ○

      added the new PreratedPricing enum value to the request property allOf[subschema #1]/ChargeModel

      request-property-enum-value-added

    • ○

      added the new SPECIFIC_DAYS enum value to the request property allOf[subschema #1]/ValidityPeriodType

      request-property-enum-value-added

    • ○

      added the new SPECIFIC_MONTHS enum value to the request property allOf[subschema #1]/ValidityPeriodType

      request-property-enum-value-added

    • ○

      added the new SPECIFIC_WEEKS enum value to the request property allOf[subschema #1]/ValidityPeriodType

      request-property-enum-value-added