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 Rate Plan Definitions API

Use product rate plan definitions to reuse charges in different product rate plans.The Product Rate Plan 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 Rate Plan 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 Rate Plan Definitions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

4 operations 2 paths 5 schemas 1 DELETE2 GET1 POST

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 4

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

Product Rate Plan Definitions 4

Use product rate plan definitions to reuse charges in different product rate plans. The Product Rate Plan Definition object is in the Early Adopter phase. We are actively soliciti…

POST
/v1/product-rateplan-definitions
Create a product rate plan definition
POST_CreateProductRatePlanDefinition 7 params → 200
GET
/v1/product-rateplan-definitions
List product rate plan definitions
GET_RetrieveProductRatePlanDefinitions 7 params → 200
GET
/v1/product-rateplan-definitions/{product-rateplan-definition-key}
Retrieve a product rate plan definition
GET_RetrieveProductRatePlanDefinition 6 params → 200
DELETE
/v1/product-rateplan-definitions/{product-rateplan-definition-key}
Delete a product rate plan definition
DELETE_ProductRatePlanDefnition 6 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are GETProductRatePlanDefinitionResponse (8 properties), POSTRatePlanDefinitionRequest (4 properties), CommonResponseType (3 properties), POSTRatePlanDefinitionResponse (2 properties). Each schema is shown below with its type and property counts.

GETProductRatePlanDefinitionsResponse
object
2 properties
GETProductRatePlanDefinitionResponse
object
8 properties
CommonResponseType
object
3 properties
POSTRatePlanDefinitionResponse
object
2 properties
POSTRatePlanDefinitionRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-product-rate-plan-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