How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Ramps API

A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where products or pricing can change. These periods are sub time containers to enable you to report out-of-the-box metrics based on Ramp Intervals.**Notes**: You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations.For more information, see Ramps and Ramp Metrics.

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

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

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

Requests are made against a single base URL, https://rest.zuora.com/.

5 operations 5 paths 15 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-12-15
Server
https://rest.zuora.com/
Resource Areas
1

Paths & Operations 5

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

Ramps 5

A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where pro…

GET
/v1/ramps/{rampNumber}
Retrieve a ramp
GET_RampByRampNumber 7 params → 200
GET
/v1/ramps/{rampNumber}/ramp-metrics
List all ramp metrics of a ramp
GET_RampMetricsByRampNumber 7 params → 200
GET
/v1/subscriptions/{subscriptionKey}/ramps
Retrieve a ramp by subscription key
GET_RampsBySubscriptionKey 7 params → 200
GET
/v1/subscriptions/{subscriptionKey}/ramp-metrics
List ramp metrics by subscription key
GET_RampMetricsBySubscriptionKey 7 params → 200
GET
/v1/orders/{orderNumber}/ramp-metrics
List ramp metrics by order number
GET_RampMetricsByOrderNumber 7 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RampIntervalChargeMetrics (14 properties), OrderRampIntervalMetrics (12 properties), RampIntervalMetrics (11 properties), RampIntervalChargeDeltaMetrics (11 properties). Each schema is shown below with its type and property counts.

RampMetrics
object
10 properties
GETRampMetricsByOrderNumberResponseType
GETRampsBySubscriptionKeyResponseType
RampChargeResponse
object
1 property
GETRampByRampNumberResponseType
CommonResponseType
object
3 properties
RampIntervalMetrics
object
11 properties
OrderRampIntervalMetrics
object
12 properties
GETRampMetricsBySubscriptionKeyResponseType
GETRampMetricsByRampNumberResponseType
RampResponse
object
7 properties
RampIntervalChargeDeltaMetrics
object
11 properties
RampIntervalResponse
object
4 properties
RampIntervalChargeMetrics
object
14 properties
OrderRampMetrics
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-ramps-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
Where this information came from

This is an independent, third-party profile of Zuora Ramps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.