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

Use offers to define different product packages with multiple prices for all charge types across different geographic regions, sales areas, customers, or billing frequencies, for example.The Offer object is in the **Beta** phase.

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

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

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

4 operations 2 paths 16 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.

Offers 4

Use offers to define different product packages with multiple prices for all charge types across different geographic regions, sales areas, customers, or billing frequencies, for…

POST
/v1/offers
Create an offer
POST_CreateOffer 8 params → 200
GET
/v1/offers
List offers
GET_ListOffers 8 params → 200
GET
/v1/offers/{offer-key}
Retrieve an offer
GET_RetrieveOffer 7 params → 200
DELETE
/v1/offers/{offer-key}
Delete an offer
DELETE_Offer 7 params → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are GETOfferPriceBookItem (15 properties), GETOfferChargeConfiguration (12 properties), POSTOfferChargeConfiguration (11 properties), GETOfferResponse (10 properties). Each schema is shown below with its type and property counts.

GETOfferResponse
object
10 properties
POSTOfferResponse
object
3 properties
GETOfferChargeConfiguration
object
Container for the configurations of the product rate plan charge.
12 properties
CommonResponseType
object
3 properties
POSTOfferIntervalPrice
object
6 properties 2 required
POSTOfferTier
object
5 properties 3 required
GETOfferIntervalPrice
object
6 properties
ListAllOffersResponse
object
3 properties
GETOfferPriceBookItem
object
15 properties
GETOfferProductRatePlanCharge
object
10 properties
POSTOfferProductRatePlan
2 required
POSTOfferPriceBookItem
object
8 properties 1 required
GETOfferTier
object
5 properties
POSTOfferChargeOverride
object
3 properties 2 required
POSTOfferRequest
POSTOfferChargeConfiguration
object
Container for the configurations of the product rate plan charge.
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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