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

A product is an item or service that your company sells. In the subscription economy, a product is generally a service that your customers subscribe to rather than a physical item that they purchase one time. For example, customers subscribe to a service that provides them a car when and where they need a car rather than buying a car outright.A Product object contains all of the items in a specific product, especially product rate plans and product rate plan charges. Each Product object can have multiple rate plans, which in turn can each have multiple rate plan charges. Each rate plan charge can have multiple tiers. Taken together, all of these items create a single product.Customers subscribe to products that are in your product catalog. Product objects collectively compose your product catalog. You create your product catalog by creating products. As soon as you create your first product, you create your product catalog.

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

Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification.

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

4 operations 2 paths 10 schemas 1 DELETE1 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 4

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

Products 4

A product is an item or service that your company sells. In the subscription economy, a product is generally a service that your customers subscribe to rather than a physical item…

POST
/v1/object/product
CRUD: Create a product
Object_POSTProduct 10 params → 200400401
GET
/v1/object/product/{id}
CRUD: Retrieve a product
Object_GETProduct 9 params → 200401404
PUT
/v1/object/product/{id}
CRUD: Update a product
Object_PUTProduct 10 params → 200401
DELETE
/v1/object/product/{id}
CRUD: Delete a product
Object_DELETEProduct 7 params → 200401

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ProductObjectNSFields (4 properties), ProxyNoDataResponse (3 properties), ProxyDeleteResponse (2 properties), ProxyCreateOrModifyResponse (2 properties). Each schema is shown below with its type and property counts.

ProxyDeleteResponse
object
2 properties
ProxyUnauthorizedResponse
object
1 property
ProxyNoDataResponse
object
3 properties
ProductObjectCustomFields
object
Container for custom fields of a Product object.
ProxyCreateProduct
ProxyGetProduct
ProxyCreateOrModifyResponse
object
2 properties
ProxyModifyProduct
ProductObjectNSFields
object
Container for Product fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
4 properties
ProxyBadRequestResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-products-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