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!

 

2019-06-20

 

API Updates

 

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

 

The following API updates are available as of Zuora Release 249, June 2019.

 

  • Payment Methods - Added the cardSecurityCode field in the request body of the “Create stored credential profile” operation.

 

Doc Updates

 

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

 

  • In the request body of the “Subscribe” action, added the description for the subscribes > PreviewOptions > EnablePreviewMode field as a workaround to avoid potential charges for payment method validation in subscription and amendment previews.

  • In the descriptions of the "Create order" and "Preview order" operations, added notes to inform customers about the limits on Orders.

  • In the Authorization header parameter of the following operations, added the description that the OAuth token must be regenerated after the Notification and the Configurable Event features are enabled in your Zuora tenant:

    • Create a notification definition
    • Query notification definitions
    • Update a notification definition
    • Get a notification definition
    • Delete a notification definition
    • Create an email template
    • Query email templates
    • Update an email template
    • Get an email template
    • Delete an email template
  • In the eventCategory query parameter of the following operations, added the description that two formats are supported:

    • Get callout notification histories
    • Get email notification histories
  • In the response body of the "Get account" operation, added the missing sequenceSetId nested field to the basicInfofield.

  • Corrected the endpoint URL of the "Upload file for invoice" operation to /v1/invoices/{invoice-id}/files.

  • Corrected the endpoint URL of the "Upload file for credit memo" operation to /v1/creditmemos/{creditMemoId}/files.

  • Corrected the endpoint URL of the "Upload file for debit memo" operation to /v1/debitmemos/{debitMemoId}/files.

  • In the following operations, changed the path parameter name from invoice-id to invoiceId.

    • Get invoice files
    • Get invoice items
  • In the “Get taxation items of invoice item” operation, changed the following path parameter names:

    • Changed invoice-id to invoiceId
    • Changed item-id to itemId
  • In the response body of the "Get product catalog" operation, corrected the URL example in the description of the products > productRatePlans field.

  • In the response body of the "Get product" operation, corrected the URL example in the description of the productRatePlans field.