Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Product Charge Definitions API

Use product charge definitions to define the attributes that can determine the charge behavior, such as billing attributes, pricing attributes, taxation attributes, or accounting attributes.The Product Charge Definition object is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you are interested, please reach out to your CSM.

Zuora Product Charge Definitions API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product Charge Definitions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

7 operations 3 paths 17 schemas 1 DELETE2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Product Charge Definitions 7

Use product charge definitions to define the attributes that can determine the charge behavior, such as billing attributes, pricing attributes, taxation attributes, or accounting…

POST
/v1/product-charge-definitions
Create a product charge definition
POST_CreateProductChargeDefinition 7 params → 200
GET
/v1/product-charge-definitions
List product charge definitions
GET_RetrieveProductChargeDefinitions 8 params → 200
POST
/v1/product-charge-definitions/bulk
Create product charge definitions
POST_CreateProductChargeDefinitionBulk 7 params → 200
PUT
/v1/product-charge-definitions/bulk
Update product charge definitions
PUT_UpdateProductChargeDefinitionBulk 6 params → 200
GET
/v1/product-charge-definitions/{product-charge-definition-key}
Retrieve a product charge definition
GET_RetrieveProductChargeDefinition 7 params → 200
PUT
/v1/product-charge-definitions/{product-charge-definition-key}
Update a product charge definition
PUT_UpdateProductChargeDefinition 7 params → 200
DELETE
/v1/product-charge-definitions/{product-charge-definition-key}
Delete a product charge definition
DELETE_ProductChargeDefnition 6 params → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are GETProductChargeDefinitionResponse (65 properties), POSTChargeDefinitionRequest (29 properties), PUTProductChargeDefinitionRequest (25 properties), PUTBulkProductChargeDefinitionRequest (24 properties). Each schema is shown below with its type and property counts.

CommonResponseType
object
3 properties
GETChargeDefinitionPricingTier
array
An array of charge pricing tiers.
PUTProductChargeDefinitionBulkRequest
object
1 property
POSTChargeDefinitionRequestBulk
object
1 property
GETDeliverySchedule
object
8 properties
PUTBulkProductChargeDefinitionRequest
object
24 properties
POSTProductChargeDefinitionPricing
object
5 properties
ProductChargeDefinitionObjectCustomFields
object
Container for custom fields of a Product Charge Definition object.
PUTProductChargeDefinitionRequest
object
25 properties
GETProductChargeDefinitionResponse
object
65 properties
POSTChargeDefinitionBulkResponse
object
1 property
GETProductChargeDefinitionsResponse
object
2 properties
GETProductDiscountApplyDetailsType
object
2 properties
POSTChargeDefinitionResponse
object
3 properties
POSTChargeDefinitionPricingTier
array
An array of charge pricing tier.
POSTChargeDefinitionRequest
object
29 properties
GETProductChargeDefinitionPricing
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-product-charge-definitions-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API