POST /v1/product-charge-definitions

Default value: "application/json"

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.

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

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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.

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 do not need to set this header.

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.

The default quantity.

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

The billing period for the product charge definition.

Container for the prices of the product charge definition.

The price of this item.

This field is only applicable for charges based on the following charge models:

• Flat Fee
• Per Unit
• Delivery Pricing

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"
  }
]

The percentage of discount for a percentage discount. The field is applicable only for charges based on the Discount-Percentage charge model.

The currency for the price.

The specific amount for a fixed discount. The field is applicable only for charges based on the Discount-Fixed Amount charge model.

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

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

Possible values:

• "FlatFee"
• "Volume"
• "DiscountPercentage"
• "PerUnit"
• "Tiered"
• "Delivery"
• "DiscountFixedAmount"

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.

Possible values:

• "Per_Billing_Period"
• "Per_Year"
• "Per_Month"
• "Per_Week"

The effective start date of the product charge definition.

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.

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

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

The effective end date of the product charge definition.

The type of the subscription that is eligible for this charge definition.

Possible values:

• null
• "EVERGREEN"
• "TERMED"

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.

The billing timing setting for the product charge definition.

Possible values:

• "IN_ARREARS"
• "IN_ADVANCE"

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.

The unique ID of the charge of the charge definition.

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.

Possible values:

• null
• "TaxExclusive"
• "TaxInclusive"

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.

Specifies the period type for the subscription term that is eligible for this charge definition.

Possible values:

• "Week"
• null
• "Day"
• "Year"
• "Month"

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

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