Zuora Documentation

Re: API Changelog

  • 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-30

  •  

  • API Updates

  •  

    This section lists operations and fields that were added, changed, or removed.

  •  

    The following API updates are available as of September 30, 2020.

  •  

    • Charge Metrics - Added a resource called "Charge Metrics", with the following operations:
      • Get charge metrics
      • Get discount allocation details

     

  • The High Water Mark Volume Pricing, High Water Mark Tiered Pricing, Pre-Rated Per Unit Pricing, Pre-Rated Pricing, and Multi-Attribute Pricing charge models are now generally available as of September 30, 2020. The following updates are specific to these charge models.

  •  

    • Subscriptions - Made the following updates

      • In the request body of each of the following operations, updated the description of the subscribeToRatePlans > chargeOverrides > chargeModelConfiguration field and its nested fields:
        • Preview subscription
        • Create subscription
      • In the request body of the "Update subscription" operations, updated the description of each of the following fields and their nested fields:
        • add > chargeOverrides > chargeModelConfiguration
        • update > chargeUpdateDetails > chargeModelConfiguration
      • In response body of the "Get subscriptions by account" operation, updated the description of the subscriptions > ratePlans > ratePlanCharges > chargeModelConfiguration field and its nested fields.
      • In response body of the following operations, updated the description of the ratePlans > ratePlanCharges > chargeModelConfiguration field and its nested fields:
        • Get subscriptions by key
        • Get subscriptions by key and version
    • Orders - Made the following updates:

      • In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, updated the description of each of the following fields and their nested 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 each of the following operations, updated the description of the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData field and its nested fields:

        • Get an order
        • Get order metrics for evergreen subscription
      • In the response body of the following operations, updated the description of the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData field and its nested fields:

        • 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 request body of the "CRUD: Create product rate plan charge" and "CRUD: Update product rate plan charge" operations, updated the description of each of the following enum values for the ChargeModel field:
        • MultiAttributePricing
        • PreratedPerUnit
        • PreratedPricing
        • HighWaterMarkVolumePricing
        • HighWaterMarkTieredPricing
      • In the request body of each of the following operations, updated the description of 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, made the following updates:

      • Updated the description of each of the following fields:
        • productRatePlans > productRatePlanCharges > pricingSummary
        • formula
      • Updated the description of each of the following enum values for the productRatePlans > productRatePlanCharges > model field:
        • MultiAttributePricing
        • PreratedPerUnit
        • PreratedPricing
        • HighWatermarkVolumePricing
        • HighWatermarkTieredPricing

     

  • Doc Updates

     

  • This section lists the documentation updates that were made in this version of the API Reference.

  •  

    • In the request body of the “Create a notification definition” operation, updated the description of the eventTypeNamespace field.