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 Plans API

A product rate plan is the part of a product that your customers subscribe to. Each product can have multiple product rate plans, and each product rate plan can have multiple product rate plan charges, which are fees for products and their product rate plans.

Zuora Product Rate Plans 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 Plans. The published artifact set on APIs.io includes an OpenAPI specification.

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

7 operations 5 paths 21 schemas 1 DELETE4 GET1 POST1 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 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Product Rate Plans 7

A product rate plan is the part of a product that your customers subscribe to. Each product can have multiple product rate plans, and each product rate plan can have multiple prod…

GET
/v1/products/{product-key}/product-rate-plans
List all product rate plans of a product
GET_ProductRatePlans 10 params → 200
GET
/v1/product-rate-plans/{id}
Retrieve a product rate plan by ID
GET_ProductRatePlan 7 params → 200
GET
/v1/product-rate-plans/external-id/{id}
List product rate plans by external ID
GET_ProductRatePlansByExternalID 7 params → 200
POST
/v1/object/product-rate-plan
CRUD: Create a product rate plan
Object_POSTProductRatePlan 10 params → 200400401
GET
/v1/object/product-rate-plan/{id}
CRUD: Retrieve a product rate plan
Object_GETProductRatePlan 9 params → 200401404
PUT
/v1/object/product-rate-plan/{id}
CRUD: Update a product rate plan
Object_PUTProductRatePlan 10 params → 200401
DELETE
/v1/object/product-rate-plan/{id}
CRUD: Delete a product rate plan
Object_DELETEProductRatePlan 7 params → 200401

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ProductRatePlanChargeObjectNSFields (14 properties), GETProductRatePlanWithExternalIdResponse (12 properties), ProductRatePlanObjectNSFields (12 properties), GETProductRatePlanChargeDeliverySchedule (8 properties). Each schema is shown below with its type and property counts.

ProxyDeleteResponse
object
2 properties
ProductRatePlanChargeObjectCustomFields
object
Container for custom fields of a Product Rate Plan Charge object.
ProxyUnauthorizedResponse
object
1 property
GETProductRatePlanWithExternalIdResponse
object
12 properties
ProxyNoDataResponse
object
3 properties
ProductRatePlanObjectNSFields
object
Container for Product Rate Plan fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
12 properties
GETProductRatePlanChargeType
GETProductRatePlanChargePricingTierType
object
5 properties
GETProductRatePlanChargePricingType
object
7 properties
ProxyModifyProductRatePlan
GETProductRatePlanType
ProductRatePlanChargeObjectNSFields
object
Container for Product Rate Plan Charge fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
14 properties
GETProductRatePlansResponse
object
3 properties
ProxyCreateOrModifyResponse
object
2 properties
GETProductDiscountApplyDetailsType
object
2 properties
GETProductRatePlanWithExternalIdMultiResponse
array
ProxyGetProductRatePlan
ProxyCreateProductRatePlan
ProductRatePlanObjectCustomFields
object
Container for custom fields of a Product Rate Plan object.
GETProductRatePlanChargeDeliverySchedule
object
The delivery schedule information of this charge. Only when this charge is using Delivery Pricing charge model
8 properties
ProxyBadRequestResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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