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-11-08

 

API Updates

 

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 234, November 2018.

 

  • Orders - Made the following updates:

    • In the “Create order” operation, made the following updates to the request body:

      • Added the includedUnits field to the subscriptions > orderActions > updateProduct > chargeUpdates > pricing field.
      • Added the additionalEmailAddresses, customerServiceRepName, purchaseOrderNumber, salesRep, and allowInvoiceEdit fields to the following fields:
        • newAccount
        • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount
      • Added the contactDescription field to the following fields:
        • newAccount > billToContact
        • newAccount > soldToContact
        • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact
        • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact
      • Added the revRecCode, revenueRecognitionRuleName, and revRecTriggerCondition fields to the subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field.
    • In the “Preview order” operation, made the following updates to the request body:

      • Added the includedUnits field to the subscriptions > orderActions > updateProduct > chargeUpdates > pricingfield.
      • Added the taxInfo nested field to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field.
      • Added the additionalEmailAddresses, customerServiceRepName, purchaseOrderNumber, salesRep, and allowInvoiceEdit fields to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field.
      • Added the contactDescription field to the following fields:
        • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact
        • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact
      • Added the revRecCode, revenueRecognitionRuleName, and revRecTriggerCondition fields to the subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field.
    • In the “Get an order” operation, added the revRecCode, revenueRecognitionRuleName, and revRecTriggerCondition fields to the order> subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field in the response body.

    • In the following operations, added the contactDescription field to the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans> chargeOverrides field in the response body:

      • Get all orders
      • Get orders by subscription owner
      • Get orders by subsription number
      • Get orders by invoice owner
  • Payment Methods - Made the following updates:

    • Added support for custom fields in the request body of the following operations:
      • Create payment method
      • Create credit card payment method
      • Update credit card payment method
      • CRUD: Create payment method
      • CRUD: Update payment method
    • Added a note to the description of the accountID, accountKey, or AccountId field in the following operations to explain when the ID of customer account can be optional:
      • Create credit card payment method
      • Create Apple Pay payment method
      • Update credit card payment method
      • CRUD: Create payment method
      • CRUD: Update payment method
  • Accounts - Added support for custom fields to the creditCard object in the request body of the ‘‘Create account’’ operation.

  • Notifications - Made the following updates:

    • Added the eventTypeNamespace field to the request body of the following operations:
      • Create a notification definition
      • Create an email template
    • Added the eventTypeNamespace field to the 200 response schema of the following operations:
      • Create a notification definition
      • Query notification definitions
      • Update a notification definition
      • Get a notification definition
      • Create an email template
      • Query email templates
      • Update an email template
      • Get an email template
  • Invoices - In the response body of the “Get invoice items” operation, added the nested appliedToItemId field to the invoiceItems field.

  • Operations - In the response body of the “Create billing preview” operation, added the nested appliedToItemId field to the following fields:

    • invoiceItems
    • creditMemoItems
  • Transactions - In the response body of the “Get invoices” operation, added the nested reversed field to the invoices field.