Sign in
Product Charge Definitions

Create a product charge definition

Creates a product charge definition for a charge. You can create as many product charge definitions as needed for one charge.

In the request, you must specify the unique ID or number of the charge for which this charge definition is to be created. The ID or number of a product rate plan is optional.

Note: This operation requires the Attribute-based Pricing feature to be enabled, which is in the Early Adopter phase.

post/v1/product-charge-definitions

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-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 (').

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-Versionstring

The minor API version.

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

Request body

billingPeriodstring

The billing period for the product charge definition.

billingTiming'IN_ADVANCE' | 'IN_ARREARS'

The billing timing setting 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.

defaultQuantitynumber nullable

The default quantity.

This field is applicable only for one-time and recurring charges.

effectiveEndDatestring date-time

The effective end date of the product charge definition.

effectiveStartDatestring date-time

The effective start date of the product charge definition.

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 <a href="https://docs.zuora.com?resourceId=billing-annual-list-price" target="_blank">Annual List Price</a> feature enabled.

productRatePlanChargeIdstring

The unique ID of the charge of the charge definition.

productRatePlanChargeNumberstring

The unique number (natural key) of the charge of the charge definition.

productRatePlanIdstring

The unique ID of the product rate plan that uses this charge definition.

productRatePlanNumberstring

The unique number (natural key) of the product rate plan that uses this charge definition.

specificBillingPeriodnumber nullable

The specific number of billing periods for the product charge definition.

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

taxCodestring

Specifies the tax code for taxation rules. This field is required 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 required when the Taxable field is set to True.

Note: This value affects the tax calculation of the charge.

taxableboolean

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.

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

uomstring nullable

Describes the unit of measure (UOM) configured in Settings > Billing for the charge.

Example request

{
  "productRatePlanChargeId": "edcab92612893256dce329d0b377000e",
  "effectiveStartDate": "2024-01-01 00:00:00",
  "effectiveEndDate": "2025-01-01 00:00:00",
  "listPriceBase": "Per_Billing_Period",
  "prices": [
    {
      "currency": "USD",
      "price": 12
    }
  ]
}

Response

OK

chargeDefinitionIdstring

The unique ID of the product charge definition.

chargeDefinitionNumberstring

The unique number (natural key) of the product charge definition.

successboolean

Indicates whether the request succeeded.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.