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-10-18

 

Doc Updates

 

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

 

  • In the following operations, corrected the possible values of the status field in the response body:

    • Get subscriptions by key
    • Get subscriptions by key and version

    Previously, the value Pending Activation was incorrectly listed as PendingActivation, and the value Pending Acceptance was incorrectly listed as PendingAcceptance.

  • In the “Get subscriptions by account” operation, corrected the possible values of the subscriptions > status field in the response body.

    Previously, the value Pending Activation was incorrectly listed asPendingActivation, and the value Pending Acceptance was incorrectly listed as PendingAcceptance.

  • In the “CRUD: Retrieve Subscription” operation, corrected the possible values of the status field in the response body.

    Previously, the value Pending Activation was incorrectly listed asPendingActivation, and the value Pending Acceptance was incorrectly listed as PendingAcceptance.

  • In the “CRUD: Update Subscription” operation, corrected the possible values of the status field in the request body.

    Previously, the value Pending Activation was incorrectly listed asPendingActivation, and the value Pending Acceptance was incorrectly listed as PendingAcceptance.

  • In the “Post usage” operation, changed the following headings from required to optional. Although the values for the following headings are not required, the heardings themselves must exist in the upload CSV file.

    • ENDDATE
    • SUBSCRIPTION_ID
    • CHARGE_ID
  • At the beginning of the Accounts section, explained similar operations are provided for different use scenarios.

  • At the beginning of the Subscription Product Features section, noted that the Entitlements feature must be enabled to use the operation.

  • In the “CRUD: Delete amendment” operation, explained that invoiced amendments cannot usually be deleted, unless it is the last auto-renew amendment.