Zuora Documentation

Re: API Changelog

2018-06-28

 

API Updates

 

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

 

  • Payment Methods - Added a new operation called “Scrub payment method”.

 

Doc Updates

 

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

 

  • In the Zuora Object Model section, corrected the API name of the Billing Run object and clarified that the Billing Run object has different API names in different contexts. Previously the API name was listed as BillRun, which is incorrect for the “Describe object” operation.

  • Made the following updates to the request body of the “Subscribe” action:

    • Corrected the description of the subscribes > PreviewOptions field and the descriptions of its nested fields.
    • Removed the subscribes > PreviewOptions > IncludeExistingDraftInvoiceItems field.
  • In the “Get breakdown of invoice by order” operation, added the description for the Phantom Invoice Item feature.

  • In the “Create order” operation, added the missing zuora-version parameter to header parameters.

  • In the request body of the “Preview order” operation, corrected the previewOptions field from optional to required.

 

 

2018-06-21

 

API Updates

 

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

 

  • Payment Methods - Added a new operation called “Create payment method”. The previous operation with this name is now called “Create credit card payment method”.

  • Notifications - Made the following updates:

    • Removed the filterRule > name field from the request schema and sample of the following operations:
      • Create a notification definition
      • Update a notification definition
    • Removed the filterRule > name field from the response schema and 200 response sample of the following operations:
      • Create a notification definition
      • Query notification definitions
      • Update a notification definition
      • Get a notification definition
  • Orders - In the “Create order” operation, made the following updates:

    • In the request body, added the invoiceDeliveryPrefsPrint and invoiceDeliveryPrefsEmail fields to the following fields:
      • newAccount
      • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount
    • In the request body, updated the processingOptions > ElectronicPaymentOptions > PaymentMethodId field to reflect the enhancement that if an orphan payment method is specified in this field, this operation will associate the payment method with the account that this order will be created under, regardless of whether the payment has been processed.

 

Doc Updates

 

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

  • Added a new subsection called Timeout Limit in the Requests and Responses section.

  • In the “Create credit memo from charge” and “Create debit memo from charge” operations, made the following updates:

    • Added the missing zuora-version parameter to header parameters.
    • Added the missing charges > memoItemAmount field to the request body. This field is in Zuora API version control and only available in Zuora REST API version 223.0 and earlier. Added this field to the Minor Version History section accordingly.
    • In the description of the charges > amount field in the request body, noted that this field is in Zuora API version control and only available in Zuora REST API version 224.0 and later. Added this field to the Minor Version History section accordingly.
  • Changed the name of the “Create payment method” operation to “Create credit card payment method”. A new operation called “Create payment method” is now available.

  • Changed the name of the “Update payment method” operation to “Update credit card payment method”.

  • Changed the name of the “Get payment methods” operation to “Get credit card payment methods for account”.

  • Corrected the 200 response schema in the “Delete” action. Previously the response schema was an object called result.

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

    • Added the missing subscriptionsNumbers field to the request body. This field is in Zuora API version control and only available in Zuora REST API version 222.4 and earlier. Added this field to the Minor Version History section accordingly.
    • In the description of the subscriptions field in the request body, noted that this field is in Zuora API version control and only available in Zuora REST API version 223.0 and later. Added this field to the Minor Version History section accordingly.
  • In the “Preview order” operation, made the following updates:

    • Corrected the definition of the previewResult > orderMetrics > orderActions > orderMetrics field in the response body. Previously it was defined as an array of array. Additionally, made the following updates in the source YAML file for this correction:
      • Changed the OrderMetrics reference object name to orderMetric.
      • Redefined the orderMetric reference object  as an object. Previously, it was defined as an array.
  • In the “Get an order” operation, changed the definition of the Order > subscriptions > orderActions > orderMetrics field from a reference to the OrderMetrics object to an array that contains items of the orderMetric reference object.

  • In the following operations, changed the definition of the Orders > subscriptions > orderActions > orderMetrics field from a reference to the OrderMetrics object to an array that contains items of the orderMetric reference object:

    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner