This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!
2020-09-25
API Updates
This section lists operations and fields that were added, changed, or removed.
The following API updates are available as of September 25, 2020.
Orders - Made the following updates:
In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, added the tiers field and its nested fields to the following fields:
subscriptions > orderActions > addProduct > chargeOverrides > pricing > chargeModelData
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData
In the response body of the following operations, added the tiers field and its nested fields to the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData field:
Get an order
Get order metrics for evergreen subscription
In the response body of the following operations, added the tiers field and its nested fields to the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData field:
Get all orders
Get orders by subscription owner
Get orders by subscription number
Get orders by invoice owner
Product Rate Plan Charges - Made the following updates:
In the following operations, added the X-Zuora-WSDL-Version request header parameter:
CRUD: Create product rate plan charge
CRUD: Update product rate plan charge
In the request body of the "CRUD: Create product rate plan charge" and "CRUD: Update product rate plan charge" operations, added the following enum values to the ChargeModel field:
MultiAttributePricing
PreratedPerUnit
PreratedPricing
HighWaterMarkVolumePricing
HighWaterMarkTieredPricing
In the request body of each of the following operations, added the ChargeModelConfiguration field and its nested fields.
CRUD: Create product rate plan charge
CRUD: Update product rate plan charge
Product Rate Plans - In the response body of the "Get product rate plans" operation, added the following nested fields to the productRatePlans > productRatePlanCharges field:
chargeModelConfiguration
formula
Doc Updates
This section lists the documentation updates that were made in this version of the API Reference.
In the "Access to the API" section, added the base URLs for REST endpoints of the following enviroments:
US Cloud Production
US Cloud API Sandbox
US Central Sandbox
EU Central Sandbox
In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, corrected the name of the ChargeModelConfiguration nested field to chargeModelConfiguration in the following fields:
subscriptions > orderActions > addProduct > chargeOverrides > pricing > chargeModelData
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData
In the response body of the following operations, corrected the name of the ChargeModelConfiguration nested field to chargeModelConfiguration for the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData field:
Get an order
Get order metrics for evergreen subscription
In the response body of the following operations, corrected the name of the ChargeModelConfiguration nested field to chargeModelConfiguration for the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData field:
Get all orders
Get orders by subscription owner
Get orders by subscription number
Get orders by invoice owner
In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, updated the following fields from optional to required:
subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeTiered > tiers > priceFormat
subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeVolume > tiers > priceFormat
subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringTiered > tiers > priceFormat
subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringVolume > tiers > priceFormat
subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTiered > tiers > priceFormat
subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTieredWithOverage > tiers > priceFormat
subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > oneTimeTiered > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > oneTimeVolume > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > recurringTiered > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > recurringVolume > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageTiered > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageTieredWithOverage > tiers > priceFormat
subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageVolume > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeTiered > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeVolume > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringTiered > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringVolume > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTiered > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTieredWithOverage > tiers > priceFormat
subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > tiers > priceFormat
... View more