Create product charge definitions

Bulk creates product charge definitions for a charge. You can create up to 1000 product charge definitions at a given time for a specific 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.

Request

header Parameters

Idempotency-Key	string <= 255 characters 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-Encoding	string 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-Encoding	string 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.
Authorization	string The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
Zuora-Track-Id	string <= 64 characters 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-Ids	string 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.

Request Body schema: application/json
required

Array of objects (productChargeDefinitions)

Container for the array of product charge definition.

Responses

200

500

Internal Server Error

4XX

Request Errors

post/v1/product-charge-definitions/bulk

Request samples

Payload
cURL

application/json

{"productChargeDefinitions": [{"billingPeriod": "Specific_Months",
"chargeModel": "FlatFee",
"defaultQuantity": 10,
"effectiveEndDate": "2025-01-01 00:00:00",
"effectiveStartDate": "2024-01-01 00:00:00",
"listPriceBase": "Per_Billing_Period",
"prices": [{"currency": "USD",
"price": 10
}
],
"productRatePlanChargeId": "2c9890e489f227bd0189f22f3482001f",
"productRatePlanChargeNumber": "PRPC-00000015",
"productRatePlanId": "2c9890e489f227bd0189f22c3c730002",
"productRatePlanNumber": "PRP-NEW-00000242",
"specificBillingPeriod": 10,
"specificListPriceBase": 101,
"taxCode": "a valid tax code",
"taxMode": "TaxExclusive",
"taxable": false,
"term": 24,
"termPeriodType": "Month",
"termType": "TERMED",
"uom": "Each"
}
]
}

Response samples

application/json

{"summary": {"successCount": 1,
"failureCount": 1,
"failures": [1
]
},
"results": [{"chargeDefinitionId": "test8a90988c8b177a24018b17857411002a",
"chargeDefinitionNumber": "CD-00002089",
"success": true
},
{"success": false,
"processId": "5538FC6A344124EF",
"reasons": [{"code": "400",
"message": "Charge definitions in this payload have overlapping effective periods without differentiating attributes."
}
]
}
],
"success": true
}