Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.

 

For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you!

 

2018-08-29

 

Doc Updates

 

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

  • In the response body of the “Get all orders” operation, made the following updates:

    • Added the missing orders > subscriptions > orderActions> createSubscription > subscribeToRatePlans > newRatePlanId field.
    • Added the missing orders > subscriptions > orderActions> addProduct > newRatePlanId field.
    • Added the missing orders > subscriptions > orderActions> updateProduct > newRatePlanId field.
    • Removed the nonexistent orders > subscriptions > orderActions > addProduct > originRatePlanId field.
    • Removed the nonexistent orders > subscriptions > orderActions > updateProduct > originRatePlanId field.
    • Removed the nonexistent orders > subscriptions > orderActions > removeProduct > originRatePlanId field.
  • In the response bodies of the following operations:

    • Get an order
    • Get order metrics for evergreen subscription
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner

    Made the following updates:

    • Added the missing order > subscriptions > orderActions> createSubscription > subscribeToRatePlans > newRatePlanId field.
    • Added the missing order > subscriptions > orderActions> addProduct > newRatePlanId field.
    • Added the missing order > subscriptions > orderActions> updateProduct > newRatePlanId field.
    • Removed the nonexistent order > subscriptions > orderActions > addProduct > originRatePlanId field.
    • Removed the nonexistent order > subscriptions > orderActions > updateProduct > originRatePlanId field.
    • Removed the nonexistent order > subscriptions > orderActions > removeProduct > originRatePlanId field.
  • In the source YAML file, replaced the OrderActionRequest reference object by the following new reference objects:

    • A reference object called CreateOrderOrderAction that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderOrderAction that is used in the request body of the “Preview order” operation.
  • In the source YAML file, duplicated the CreateSubscription reference object as the following new reference objects:

    • A reference object called CreateOrderCreateSubscription that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderCreateSubscription that is used in the request body of the “Preview order” operation.
    • A reference object called CreateSubscriptionForEvergreen that is used in the response body of the “Get order metrics for evergreen subscription” operation.
  • In the source YAML file, duplicated the RatePlanOverride reference object as the following new reference objects:

    • A reference object called CreateOrderRatePlanOverride that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderRatePlanOverride that is used in the request body of the “Preview order” operation.
    • A reference object called RatePlanOverrideForEvergreen that is used in the response body of the “Get order metrics for evergreen subscription” operation.
  • In the source YAML file, duplicated the RatePlanUpdate reference object as the following new reference objects:

    • A reference object called CreateOrderRatePlanUpdate that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderRatePlanUpdate that is used in the request body of the “Preview order” operation.
    • A reference object called RatePlanUpdateForEvergreen that is used in the response body of the “Get order metrics for evergreen subscription” operation.
  • In the source YAML file, duplicated the ChargeOverride reference object as the following new reference objects:

    • A reference object called CreateOrderChargeOverride that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderChargeOverride that is used in the request body of the “Preview order” operation.
    • A reference object called ChargeOverrideForEvergreen that is used in the response body of the “Get order metrics for evergreen subscription” operation.
  • In the source YAML file, duplicated the ChargeUpdate reference object as the following new reference objects:

    • A reference object called CreateOrderChargeUpdate that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderChargeUpdate that is used in the request body of the “Preview order” operation.
    • A reference object called ChargeUpdateForEvergreen that is used in the response body of the “Get order metrics for evergreen subscription” operation.
  • In the source YAML file, duplicated the PricingUpdate reference object as the following new reference objects:

    • A reference object called CreateOrderPricingUpdate that is used in the request body of the “Create order” operation.
    • A reference object called PreviewOrderPricingUpdate that is used in the request body of the “Preview order” operation.
    • A reference object called PricingUpdateForEvergreen that is used in the response body of the “Get order metrics for evergreen subscription” operation.
  • In the source YAML file, removed the following reference objects:

    • OrderActionAddProduct
    • OrderActionForEvergreenAddProduct
    • OrderActionUpdateProduct
    • OrderActionForEvergreenUpdateProduct
    • OrderActionRemoveProduct
    • OrderActionForEvergreenRemoveProduct