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

A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have one or more rate plans. Rate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.Rate plans represent a price or a collection of prices for a service you sell. An individual rate plan contains all charges specific to a particular subscription.

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

This API exposes 1 operation across 1 path, and defines 49 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

1 operations 1 paths 49 schemas 1 GET

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 1

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

Rate Plans 1

A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have…

GET
/v1/rateplans/{ratePlanId}
Retrieve a rate plan
GET_RatePlan 7 params → 200

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are OrderActionRatePlanPricingUpdate (13 properties), OrderActionRatePlanAmendment (13 properties), OrderActionRatePlanChargeOverride (12 properties), DeliveryScheduleParams (8 properties). Each schema is shown below with its type and property counts.

OrderActionRatePlanUsageOveragePricingOverride
Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed pric…
OrderActionRatePlanRecurringFlatFeePricingUpdate
OrderActionRatePlanRatePlanOverride
object
Rate plan associated with a subscription.
5 properties 1 required
CommonResponseType
object
3 properties
OrderActionRatePlanChargeModelDataOverride
object
Container for charge model configuration data. Note: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricin…
2 properties
OrderActionRatePlanEndConditions
object
Specifies when a charge becomes inactive.
4 properties
OrderActionRatePlanRecurringPerUnitPricingUpdate
DeliveryScheduleParams
object
8 properties
OrderActionRatePlanChargeTier
object
5 properties 4 required
OrderActionRatePlanUsageVolumePricingOverride
Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending…
OrderActionRatePlanUsageTieredPricingUpdate
OrderActionRatePlanUsageOveragePricingUpdate
OrderActionRatePlanRecurringTieredPricingUpdate
OrderActionRatePlanOneTimeTieredPricingOverride
object
Pricing information about a one-time charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that bec…
2 properties
OrderActionRatePlanUsageTieredWithOveragePricingUpdate
OrderActionRatePlanRecurringVolumePricingUpdate
OrderActionRatePlanDiscountPricingUpdate
object
4 properties
OrderActionRatePlanUsageVolumePricingUpdate
OrderActionRatePlanAmendment
object
The amendment that is related to the subscription rate plan.
13 properties
OrderActionRatePlanDiscountPricingOverride
object
Pricing information about a discount charge.
5 properties
OrderActionRatePlanUsagePerUnitPricingUpdate
OrderActionRatePlanRecurringDeliveryPricingOverride
Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is onl…
OrderActionRatePlanTriggerParams
object
Specifies when a charge becomes active.
2 properties
OrderActionRatePlanUsageFlatFeePricingOverride
Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
OrderActionRatePlanRecurringDeliveryPricingUpdate
OrderActionRatePlanOrder
object
The order that is related to the subscription rate plan.
3 properties
OrderActionRatePlanOrderAction
object
Represents the processed order action.
6 properties
OrderActionRatePlanRecurringVolumePricingOverride
Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depen…
OrderActionRatePlanChargeOverride
object
Charge associated with a rate plan.
12 properties 1 required
OrderActionRatePlanRatePlanObjectCustomFields
object
Container for custom fields of a Rate Plan object.
OrderActionRatePlanUsageTieredWithOveragePricingOverride
Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that b…
OrderActionRatePlanUsageFlatFeePricingUpdate
OrderActionRatePlanOneTimePerUnitPricingOverride
object
Pricing information about a one-time charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
2 properties
OrderActionRatePlanRemoveProduct
object
Information about an order action of type RemoveProduct.
2 properties
OrderActionRatePlanOrderActionObjectCustomFields
object
Container for custom fields of an Order Action object.
OrderActionRatePlanUsagePerUnitPricingOverride
Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed.
OrderActionRatePlanPriceChangeParams
object
2 properties
OrderActionRatePlanOneTimeFlatFeePricingOverride
object
Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
1 property 1 required
OrderActionRatePlanOneTimeVolumePricingOverride
object
Pricing information about a one-time charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depend…
2 properties
OrderActionRatePlanChargeUpdate
object
The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.
7 properties
OrderActionRatePlanRatePlanUpdate
object
Information about an order action of type UpdateProduct.
6 properties
GetOrderActionRatePlanResponse
OrderActionRatePlanPricingUpdate
object
13 properties
OrderActionRatePlanRatePlanChargeObjectCustomFields
object
Container for custom fields of a Rate Plan Charge object.
OrderActionRatePlanRecurringPerUnitPricingOverride
Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
OrderActionRatePlanUsageTieredPricingOverride
Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become…
OrderActionRatePlanRecurringTieredPricingOverride
Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that be…
OrderActionRatePlanRecurringFlatFeePricingOverride
Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
OrderActionRatePlanBillingUpdate
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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