--- title: "Update product charge definitions" method: PUT path: "/v1/product-charge-definitions/bulk" tags: ["Product Charge Definitions"] --- # Update product charge definitions `PUT /v1/product-charge-definitions/bulk` Bulk updates multiple product charge definitions. **Note**: This operation requires the [Attribute-based Pricing](https://docs.zuora.com?resourceId=billing-attribute-based-pricing) feature to be enabled, which is in the **Early Adopter** phase. ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Version` string ## Request body - PUTProductChargeDefinitionBulkRequest - `productChargeDefinitions` PUTBulkProductChargeDefinitionRequest[] — The list of updated product charge definitions. - `billingPeriod` string — The override value of the billingPeriod for the product charge definition. - `billingTiming` 'IN_ADVANCE' | 'IN_ARREARS' — The override value of the billingTiming for the product charge definition. - `chargeModel` 'DiscountFixedAmount' | 'DiscountPercentage' | 'FlatFee' | 'PerUnit' | 'Tiered' | 'Volume' | 'Delivery' — Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration. - `defaultQuantity` number — The default quantity. This field is applicable only for one-time and recurring charges. - `listPriceBase` 'Per_Billing_Period' | 'Per_Month' | 'Per_Week' | 'Per_Year' — The list price base. This field is applicable only for recurring charges. **Note**: The `Per_Year` enum value is available only if you have the Annual List Price feature enabled. - `prices` POSTProductChargeDefinitionPricing[] — Container for the new prices to override the existing prices of the product charge definition. - `currency` string — The currency for the price. - `discountAmount` number, double — The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model. - `discountPercentage` number, double — The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model. - `price` number — The price of this item. This field is only applicable for charges based on the following charge models: - Flat Fee - Per Unit - Delivery Pricing - `tiers` POSTChargeDefinitionPricingTier[] — Container for the tiers of the price item. This field is only applicable for charges based on the following charge models: - Tiered Pricing - Volume Pricing You must 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 example: ``` [ { "startingUnit": "1", "endingUnit": "150", "currency": "USD", "price": 1.95, "priceFormat": "Per Unit" }, { "startingUnit": "151", "endingUnit": "300", "currency": "USD", "price": 1.45, "priceFormat": "Per Unit" }, { "startingUnit": "1", "endingUnit": "150", "currency": "EUR", "price": 1.75, "priceFormat": "Per Unit" }, { "startingUnit": "151", "endingUnit": "300", "currency": "EUR", "price": 1.30, "priceFormat": "Per Unit" } ] ``` - object[] — An array of charge pricing tier. - `currency` string — The code corresponding to the currency for the tier's price. - `endingUnit` number, double — The end number of a range of units for the tier. This field is required for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model. - `price` number, double — The price of the tier if the price format is flat fee, or the price of each unit in the tier if the price format is per unit. - `priceFormat` 'Flat Fee' | 'Per Unit' — The price format of the tier. - `startingUnit` number, double — The starting number of a range of units for the tier. This field is required for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model. - `productChargeDefinitionKey` string — The unique number or ID of the product charge definition to be updated. - `specificBillingPeriod` number, nullable — The override value of the specificBillingPeriod for the product charge definition. - `specificListPriceBase` integer, nullable — The number of months for the list price base of the charge definition. The field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`. - `taxCode` string — Specifies the tax code for taxation rules. This field is equired when the `Taxable` field is set to `True`. **Note**: This value affects the tax calculation of the charge. - `taxMode` 'TaxExclusive' | 'TaxInclusive' | 'null', nullable — Determines how to define taxation for the charge. This field is equired when the `taxable` field is set to `true`. **Note**: This value affects the tax calculation of the charge. - `taxable` boolean — Determines whether the charge definition is taxable. When this field is set to `true`, the `taxMode` and `taxCode` fields are required. **Character limit**: 5 **Values**: `true`, `false` **Note**: This value affects the tax calculation of the charge. - `term` number, nullable — The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, and is to be used together with the `termPeriodType` field. - `termPeriodType` 'Month' | 'Year' | 'Day' | 'Week' | 'null', nullable — Specifies the period type for the subscription term that is eligible for this charge definition. - `termType` 'TERMED' | 'EVERGREEN' | 'null', nullable — The type of the subscription that is eligible for this charge definition. - `uom` string, nullable — Describes the unit of measure (UOM) configured in **Settings > Billing**. **Values**: `Each`, `License`, `Seat`, or `null` ## Response `200` OK - GETProductChargeDefinitionsResponse - `chargeDefinitions` object[] — The list of the product charge definitions that are retrieved. - `applyDiscountTo` 'ONETIME' | 'RECURRING' | 'USAGE' | 'ONETIMERECURRING' | 'ONETIMEUSAGE' | 'RECURRINGUSAGE' | 'ONETIMERECURRINGUSAGE' | 'null', nullable — Indicates which type of charge the discount charge applies to. - `billingDay` string — The bill cycle type for the charge. - `billingPeriod` string — The billing period for the product charge definition. - `billingPeriodAlignment` 'AlignToCharge' | 'AlignToSubscriptionStart' | 'AlignToTermStart' | 'AlignToTermEnd' — The billing period alignment setting for the charge. - `billingTiming` 'IN_ADVANCE' | 'IN_ARREARS' — The billing timing setting for the product charge definition. - `chargeModel` 'DiscountFixedAmount' | 'DiscountPercentage' | 'FlatFee' | 'PerUnit' | 'Overage' | 'Tiered' | 'TieredWithOverage' | 'Volume' | 'Delivery' | 'MultiAttributePricing' | 'PreratedPerUnit' | 'PreratedPricing' | 'HighWatermarkVolumePricing' | 'HighWatermarkTieredPricing' — Determines how to calculate charges. Charge models must be individually activated in Zuora Billing administration. - `chargeType` 'OneTime' | 'Recurring' | 'Usage' — Indicates the type of charge. - `customFields` ProductChargeDefinitionObjectCustomFields — Container for custom fields of a Product Charge Definition object. - `defaultQuantity` number, nullable — The default quantity. This field is applicable only for one-time and recurring charges. - `deliverySchedule` GETDeliverySchedule, nullable - `frequency` 'Weekly' — The frequency of the delivery. Only weekly delivery is supported now. - `friday` boolean — The flag to indicate whether the delivery happens on Friday. - `monday` boolean — The flag to indicate whether the delivery happens on Monday. - `saturday` boolean — The flag to indicate whether the delivery happens on Saturday. - `sunday` boolean — The flag to indicate whether the delivery happens on Sunday. - `thursday` boolean — The flag to indicate whether the delivery happens on Thursday. - `tuesday` boolean — The flag to indicate whether the delivery happens on Tuesday. - `wednesday` boolean — The flag to indicate whether the delivery happens on Wendesday. - `description` string — The description for the charge. - `discountClass` string, nullable — The class that the discount belongs to. The discount class defines the order in which discount product rate plan charges are applied. For more information, see [Manage Discount Classes](https://docs.zuora.com?resourceId=billing-manage-discount-classes). - `discountLevel` 'rateplan' | 'subscription' | 'account' | 'null', nullable — The application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge. - `effectiveEndDate` string, date-time — The effective end date of the product charge definition. - `effectiveStartDate` string, date-time — The effective start date of the product charge definition. - `endDateCondition` 'Subscription_End' | 'One_Time' | 'Fixed_Period' | 'Specific_End_Date' — The end date condition for this charge. - `excludeItemBillingFromRevenueAccounting` boolean — Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — Indicates whether to exclude the related rate plan charges and order line items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. - `isAllocationEligible` boolean — Indicates whether the charge segment is allocation eligible in revenue recognition. The default value is `false`. **Values**: `true`, `false` **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `isUnbilled` boolean — Specifies how to perform the accounting during revenue recognition. The default value is `false`. **Values**: `true`, `false` **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `productCategory` string — This field is used to maintain the product category for integration with Zuora Revenue. **Note**: This field is available only if you have the Additional Revenue Fields property enabled. - `productClass` string — This field is used to maintain the product class for integration with Zuora Revenue. **Note**: This field is available only if you have the Additional Revenue Fields property enabled. - `productFamily` string — This field is used to maintain the product family for integration with Zuora Revenue. **Note**: This field is available only if you have the Additional Revenue Fields property enabled. - `productLine` string — This field is used to maintain the product line for integration with Zuora Revenue. **Note**: This field is available only if you have the Additional Revenue Fields property enabled. - `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 revenue recognition policy configuration 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 revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. - `numberOfPeriods` integer, nullable — Specifies the number of periods to use when calculating charges in an overage smoothing charge model. This field is ued when overage smoothing model is `RollingWindow` or `Rollover`. - `financeInformation` object — Container for finance information of the rate plan charge. - `accountsReceivableAccountingCode` string, nullable — The accounting code for accounts receivable. - `accountsReceivableAccountingCodeType` string, nullable — The type of the accounting code for accounts receivable. - `adjustmentLiabilityAccountingCode` string — The accounting code for adjustment liability. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `adjustmentLiabilityAccountingCodeType` string, nullable — The type associated with the adjustment liability accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `adjustmentRevenueAccountingCode` string — The accounting code for adjustment revenue. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `adjustmentRevenueAccountingCodeType` string, nullable — The type associated with the adjustment revenue accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractAssetAccountingCode` string — The accounting code for contract asset. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractAssetAccountingCodeType` string — The type associated with the contract asset accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractLiabilityAccountingCode` string — The accounting code for contract liability. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractLiabilityAccountingCodeType` string — The type associated with the contract liability accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractRecognizedRevenueAccountingCode` string — The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `contractRecognizedRevenueAccountingCodeType` string — The type associated with the contract recognized revenue accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `deferredRevenueAccountingCode` string — The accounting code for deferred revenue, such as Monthly Recurring Liability. - `deferredRevenueAccountingCodeType` string, nullable — The type associated with the deferred revenue accounting code, such as Deferred Revenue. - `recognizedRevenueAccountingCode` string — The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. - `recognizedRevenueAccountingCodeType` string, nullable — The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount. - `unbilledReceivablesAccountingCode` string — The accounting code for unbilled receivables. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `unbilledReceivablesAccountingCodeType` string — The type associated with the unbilled receivables accounting code. **Note**: This field is only available if you have the Zuora Billing - Revenue Integration feature enabled. - `isDefault` boolean — Indicates whether this charge definition is the default one for the charge. - `isStackedDiscount` boolean — **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](https://docs.zuora.com?resourceId=billing-discount-charge-models). - `listPriceBase` 'Per_Billing_Period' | 'Per_Month' | 'Per_Week' | 'Per_Year' — The list price base. This field is applicable only for recurring charges. **Note**: The `Per_Year` enum value is available only if you have the Annual List Price feature enabled. - `numberOfPeriod` integer — Indicates 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' | 'null', nullable — 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. - `priceChangeOption` 'NoChange' | 'SpecificPercentageValue' | 'UseLatestProductCatalogPricing' | 'null', nullable — 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. - `priceIncreasePercentage` number, double, nullable — Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `priceIncreaseOption` value to `SpecificPercentageValue`. **Character limit**: 16 **Values**: a decimal value between -100 and 100 - `prices` GETProductChargeDefinitionPricing[] — Container for the prices of the product charge definition. - `currency` string — The currency for the price. - `discountAmount` number, double — The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model. - `discountPercentage` number, double — The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model. - `includedUnits` number — The number of units included in this price item. This field is only applicable for charges based on the Overage Pricing charge model. - `overagePrice` number — The overage price of the price item. This field is only applicable for charges based on the Overage Pricing or Tiered with Overage Pricing charge model. - `price` number — The price of this item. This field is only applicable for charges based on the following charge models: - Flat Fee - Per Unit - Delivery Pricing - `tiers` GETChargeDefinitionPricingTier[] — Container for the tiers of the price item. This field is only applicable for charges based on the following charge models: - Tiered Pricing - Volume Pricing - Tiered with Overage Pricing - object[] — An array of charge pricing tiers. - `currency` string — The code corresponding to the currency for the tier's price. - `discountAmount` number, double — The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model. - `discountPercentage` number, double — The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model. - `endingUnit` number, double — The end number of a range of units for the tier. The field is applicable only for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model. - `overagePrice` number, double — Indicates whether the price is an overage price, which is the price when usage surpasses the last defined tier. - `price` number, double — The price of the tier if the price format is flat fee, or the price of each unit in the tier if the price format is per unit. - `startingUnit` number, double — The starting number of a range of units for the tier. The field is applicable only for charges based on the Tiered Pricing or Tiered with Overage Pricing charge model. - `productChargeDefinitionId` string — The unique ID of the product charge definition. - `productChargeDefinitionNumber` string — The unique number (natural key) of the product charge definition. - `productDiscountApplyDetails` GETProductDiscountApplyDetailsType[] — Container for the application details about a discount product rate plan charge. Only discount product rate plan charges have values for this field. - `appliedProductRatePlanChargeId` string — The ID of the product rate plan charge that the discount product rate plan charge applies to. - `appliedProductRatePlanId` string — The ID of the product rate plan that the discount product rate plan charge applies to. - `productRatePlanChargeId` string — The unique ID of the product charge of the charge definition. - `productRatePlanChargeNumber` string, nullable — The unique number (natural key) of the product charge of the charge definition. - `productRatePlanId` string, nullable — The unique ID of the product rate plan that uses this charge definition. - `productRatePlanName` string, nullable — Th name of the product rate plan that uses this charge definition. - `productRatePlanNumber` string, nullable — The unique number (natural key) of the product rate plan that uses this charge definition. - `ratingGroup` 'ByBillingPeriod' | 'ByUsageStartDate' | 'ByUsageRecord' | 'ByUsageUpload' | 'ByGroupId' | 'null', nullable — The 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`. - `recognizedRevenueAccount` string — 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](http://support.zuora.com/). - `revRecCode` string, nullable — Associates this product rate plan charge with a specific revenue recognition code. - `revRecTriggerCondition` 'ContractEffectiveDate' | 'ServiceActivationDate' | 'CustomerAcceptanceDate' | 'null', nullable — Indicates when revenue recognition begins. - `revenueRecognitionRuleName` 'Recognize upon invoicing' | 'Recognize daily over time' — Determines when to recognize the revenue for this charge. - `smoothingModel` 'RollingWindow' | 'Rollover' | 'null', nullable — Indicates the smoothing model for an overage smoothing charge model. - `specificBillingPeriod` number, nullable — The specific number of billing period for the product charge definition. - `specificListPriceBase` integer, nullable — The number of months for the list price base of the charge definition. This field is `null` if the `listPriceBase` field is not set to `Per_Specific_Months`. - `taxCode` string — Specifies the tax code for taxation rules. **Note**: This value affects the tax calculation of the rate plan charge. - `taxMode` 'TaxExclusive' | 'TaxInclusive' | 'null', nullable — Determines how to define taxation for the charge. **Note**: This value affects the tax calculation of the rate plan charge. - `taxable` boolean — Determines whether the charge definition is taxable. **Character limit**: 5 **Values**: `true`, `false` **Note**: This value affects the tax calculation of the rate plan charge. - `term` number, nullable — The number of periods of a termed subscription that is eligible for this charge definition. This field is applicable when the `termType` field is set to `TERMED`, and is to be used together with the `termPeriodType` field. - `termPeriodType` 'Month' | 'Year' | 'Day' | 'Week' | 'null', nullable — The period type for the subscription term that is eligible for this charge definition. - `termType` 'TERMED' | 'EVERGREEN' | 'null', nullable — The type of the subscription that is eligible for this charge definition. - `triggerEvent` 'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' — Specifies when to start billing the customer for the charge definition. **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. - `uom` string, nullable — Indicates the unit of measure (UOM) that is configured in **Settings > Billing** for the product rate plan charge. - `upToPeriods` number, nullable — The number of up-to periods for this charge. - `upToPeriodsType` 'Billing_Periods' | 'Days' | 'Weeks' | 'Months' | 'Years' | 'null', nullable — The up-to-periods type for this charge. - `usageRecordRatingOption` 'EndOfBillingPeriod' | 'OnDemand' | 'null', nullable — Determines how Zuora processes usage records for per-unit usage charges. - `useDiscountSpecificAccountingCode` boolean, nullable — Determines whether to define a new accounting code for the new discount charge. **Character limit**: 5 **Values**: `true`, `false` - `useTenantDefaultForPriceChange` boolean — Applies the tenant-level percentage uplift value for an automatic price change to a termed subscription's renewal. **Character limit**: 5 **Values**: `true`, `false` - `success` boolean — Indicates whether the request succeeded. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)