Zuora Documentation

Re: API Changelog

2017-12-06

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the December 2017 release, R219.

 

  • HMAC Signatures - Fixed CORS issue using the new REST APIs via API proxy. Now you can sign and make CORS enabled requests with URI like https://rest.zuora.com/v1/payment-methods/credit-cards as documented to return signature and token in addition to https://api.zuora.com/rest/v1/payment-methods/credit-cards.
  • Payment Runs - Added a new resource "Payment Runs" and the following new operations:
    • Create payment run
    • Update payment run
    • Delete payment run
    • Get payment run
    • Get payment runs
    • Get payment run summary
  • Invoices - Added the following new operations:
    • Update invoice
    • Update invoices
  • Debit Memos - Made the following updates:
    • Added a new operation "Update debit memos".
    • In the "Update debit memo" operation, added the dueDate field to the request body.
  • Orders - Added a new operation "Get term information for subscription".

 

Doc Updates

 

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

 

  • Removed the 400 response and the Errors > Field field in the 200 response of the following operations:
    • Amend
    • Create
    • Execute
    • Generate
    • Subscribe
    • Update
  • Removed the 400 response and the errors Field field in the 200 response of the "Delete" operation.
  • Removed the 400 response of the "Query" and "QueryMore" operations.
  • In the "Query" operation, added links to information about Zuora Object Query Language (ZOQL). Also noted that when querying one-time charges from ProductRatePlanCharge, you need to specify the ChargeType value as One-Time rather than OneTime.
  • In the "Subscribe" operation, clarified that the Account object cannot be updated.
  • Added a missing operation "CRUD: Create Import".
  • For Orders operations and the "Update subscription custom fields" operation, corrected the description of the success field. Previously, the description of the success field incorrectly referred to Order creation for some operations.
  • In the “Create subscription” operation, corrected the values of the subscribeToRatePlans > chargeOverrides > billCycleType field. Changed SpecificDayOfWeek to SpecificDayofWeek, and SpecificDayOfMonth to SpecificDayofMonth.
  • In the “Update subscription” operation, corrected the values the of add > chargeOverrides > billCycleType field. Changed SpecificDayOfWeek to SpecificDayofWeek, and SpecificDayOfMonth to SpecificDayofMonth.
  • Clarified the value of “expirationMonth” field is in one or two digits in the following operations:
    • Update payment method
    • Get payment method
    • Create payment method