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 Price Book Items API

Use price book items to define as many price points as needed for an individual product rate plan charge without the need of duplicating the product rate plan and rate plan charges in your catalog.The Price Book Item object is in the **Beta** phase.

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

Tagged areas include Price Book Items. The published artifact set on APIs.io includes an OpenAPI specification.

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

5 operations 2 paths 9 schemas 1 DELETE2 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 5

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

Price Book Items 5

Use price book items to define as many price points as needed for an individual product rate plan charge without the need of duplicating the product rate plan and rate plan charge…

POST
/v1/price-book-items
Create a price book item
POST_CreatePriceBookItem 8 params → 200
GET
/v1/price-book-items
List price book items
GET_ListPriceBookItems 10 params → 200
GET
/v1/price-book-items/{price-book-item-key}
Retrieve a price book item
GET_RetrievePriceBookItem 7 params → 200
PUT
/v1/price-book-items/{price-book-item-key}
Update a price book item
PUT_UpdatePriceBookItem 8 params → 200
DELETE
/v1/price-book-items/{price-book-item-key}
Delete a price book item
DELETE_PriceBookItem 7 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are GETPriceBookItemResponse (16 properties), PUTPriceBookItemRequest (7 properties), GETPriceBookItemIntervalPrice (6 properties), POSTPriceBookItemIntervalPrice (6 properties). Each schema is shown below with its type and property counts.

GETPriceBookItemIntervalPrice
object
6 properties
POSTPriceBookItemIntervalPrice
object
6 properties 2 required
POSTPriceBookItemRequest
GETPriceBookItemTier
object
5 properties
CommonResponseType
object
3 properties
ListAllPriceBookItemsResponse
object
3 properties
PUTPriceBookItemRequest
object
7 properties
GETPriceBookItemResponse
object
16 properties
POSTPriceBookItemTier
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-price-book-items-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