Happy Business Starts Here

Highlighted
Zuora Alumni

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.

Tags (1)
36 REPLIES
Zuora Alumni

Re: API Changelog

2017-06-07

 

API Updates

 

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

 

  • Billing Documents - Added a new operation “Generate billing documents by account”. Available as of the June 2017 release, R213.
  • Subscriptions - In "Update subscription" and "Preview subscription" operations, added the creditMemo field and its nested fields. If you have the Advanced AR Settlement feature enabled, these fields are available as of the May 2017 release, R212.

 

Doc Updates

 

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

 

  • Added a listing of API names to the Zuora Object Model section. The new listing is helpful if you use the “Describe object” operation to retrieve information about objects that are available in your Zuora tenant.
  • Noted that the “CRUD: Create Amendment” operation is not recommended to be used. You should use “Update subscription” to amend subscriptions. If you need to create an Amendment object, you should use “Amend”.
  • In the “Amend” operation, noted that the ListPriceBase field can only be changed if the amendment type is NewProduct.
  • In the "Create account", "Create subscription", "Update subscription", "Renew subscription", "Cancel subscription", "Resume subscription", and "Suspend subscription" operations:
    • Listed runBilling and targetDate as dependent on the zuora-version header.
    • Noted that applyCreditBalance is deprecated if you have the Advanced AR Settlement feature enabled.
    • Noted that when runBilling is set to true, a credit memo might be created if you have the Advanced AR Settlement feature enabled.
    • Noted that targetDate applies to credit memos if you have the Advanced AR Settlement feature enabled.
  • Added complete descriptions for all operations and fields related to the Advanced AR Settlement feature.
Zuora Alumni

Re: API Changelog

2017-07-12

 

API Updates

 

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

 

  • OAuth - Added a new operation for authenticating to Zuora REST API via OAuth.
  • Billing Documents - In the "Generate billing documents by account" operation, added the autoPost and subscriptionIds fields.
  • Credit Memos - In the "Get credit memo items" operation, added the fieldsFilterable and sort query parameters.
  • Debit Memos - In the "Get debit memo items" operation, added the fieldsFilterable and sort query parameters.

 

Doc Updates

 

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

 

  • In the source YAML file, removed “/v1” from the basePath and instead added “/v1" to individual endpoint paths. We did this because starting from this release, not all endpoints will contain “/v1”. Note that this update doesn’t change any existing endpoint URLs.
  • In the “Refund credit memo” operation, changed the “GETRefundType” reference object name to “GETRefundCreditMemoType” in the source YAML file.
  • Added the new URLs for the EU Data Center in the Endpoints section.
  • Added the following missing operations:
    • "Email invoice" - Sends posted invoices to the specified email addresses manually.
    • "Email credit memo" - Sends posted credit memos to the specified email addresses manually. 
    • "Email debit memo" - Sends posted debit memos to the specified email addresses manually.
  • Added the missing "Bill Runs" resource. This resource includes the "Email billing documents generated from bill run" operation to allow you to manually email all the billing documents that are generated from a specified bill run. 
  • In the "Create taxation items for credit memo", "Create taxation items for debit memo", "Update taxation item", and "Get taxation item" operations, added the missing sourceTaxItemId field.
  • Added the missing pageSize query parameter and the missing nextPage response field for the operations that support pagination.
  • Fixed the response structure of the "Query" and "QueryMore" operations by removing the result wrapper. 
  • Removed several unsupported CRUD operations.
  • Added the API Changelog section, with a link to the API Changelog in the Zuora Community.
  • Added the Concurrent Request Limits section in the Requests and Responses section, with a link to Concurrent Request Limits in the Zuora Knowledge Center.
  • Added the Data Type section in the HTTP Request Body section. This section recommends that you do not specify the decimal values with quotation marks, commas, and spaces for all actions and CRUD operations.
  • Fixed an incorrect object name in the Zuora Object Model section. Previously, the name of the Contact Snapshot object was incorrectly listed as Bill To Contact Snapshot. The corresponding API name ContactSnapshot remains correct.
  • In the "CRUD: Create Export" and "CRUD: Retrieve Export" operations:
    • Added a link to the "Get files" operation in the description of the FileId field.
    • Fixed the description of the Query field, with a link to Export ZOQL.
  • In the "Preview subscription" operation, noted that you must specify the country and state fields if you are using Zuora Tax and the country is USA or Canada.
  • In the "Get account summary" operation, corrected the description of the "Get account summary" operation. This operation does not return everything retrieved with the Get basic account information call. The response only includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages for the last six recently updated subscriptions.
  • Removed the runBilling and collect fields from the "Create account" operation example. These fields are controlled by the REST API minor version.
  • Reduced the size of the body field in the response sample of the “CRUD: Retrieve Invoice” operation.
  • Removed the Terms of Service in the source YAML file.
Zuora Alumni

Re: API Changelog

2017-08-08

 

API Updates

 

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

 

  • Credit Memos - In the "Create credit memo from charge" operation, added the serviceStartDate and serviceEndDate fields to the request body.
  • Bill Run - In the "Email billing documents generated from bill run" operation, added the resend field to the request body.
  • Operations - In the "Invoice and collect" operation, made the following updates:
    • Added the creditMemos field and its nested fields to the response.
    • Added the zuora-version field to header parameters.
    • Added the documentDate and targetDate fields to the request body. These fields are in Zuora API version control and only available in Zuora REST API version 215.0 and later.
    • In the description of the invoiceDate and invoiceTargetDate fields, noted that these fields are in Zuora API version control and only available in Zuora REST API version 214.0 and earlier.

 

Doc Updates

 

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

 

  • In the "Generate an OAuth token" operation:
    • Added usage information in the description of the operation.
    • Updated the request parameter and response field descriptions.
    • Corrected the request MIME type. The MIME type must be application/x-www-form-urlencoded, with the client_id, client_secret, and grant_type parameters specified in the request body not the query string.
    • Corrected the description of the grant_type request parameter. This parameter is required.
    • Added the missing entityName request parameter.
  • Added the missing creditMemoId response field in the "Create subscription", "Update subscription", "Renew subscription", "Cancel subscription", "Resume Subscription", "Suspend Subscription", and "Create account" operations.
  • In the “CRUD: Create Account” operation, made the following updates:
    • Removed the Balance, CreditBalance, and TotalInvoiceBalance fields from the request body.
    • Corrected the BcdSettingOption field from required to optional.
  • In the "Get accounting period" and "Get all accounting periods" operations, corrected the type of the fileIds field from array to object.
  • In the “View attachments list” operation, enumerated the possible values of the object-type query parameter and corrected the description of the object-key query parameter.
  • In the “Add attachments”, “View attachments list”, and “View attachments” operations, linked to the “Get files” operation in the description of the fileId response field.
  • Updated the nextPage field by removing the global definition of this field for the operations that support pagination.
  • Updated the CURL sample in the "Generate an OAuth token" operation.
  • Updated the description of the pricingSummary field in the "Get product catalog" operation.
  • In the Authentication section, added OAuth as the recommended way to authenticate with the Zuora REST API services.
  • Removed several unsupported CRUD operations.
  • In the "CRUD: Get payment transaction log" operation, added operation summary, operation and field descriptions.
  • In the source YAML file, corrected the operationId property of the "Email credit memo" operation to POST_EmailCreditMemo.
  • In the source YAML file, corrected the tags property of the “Generate billing documents by account” operation from Billing Documents to Accounts.
Zuora Alumni

Re: API Changelog

2017-08-16

 

API Updates

 

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

 

  • Credit Memos - Added the source and sourceId fields to the response of the “Create credit memo from charge”, “Create credit memo from invoice”, “Get credit memo”, “Get credit memos”, “Update credit memo”, “Apply credit memo”, “Unapply credit memo”, “Cancel credit memo”, “Post credit memo”, and “Query credit memos by account” operations.

 

Doc Updates

 

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

 

  • In the "Generate an OAuth token" operation, removed the entityId and entityName request parameters. Also removed a paragraph about these parameters from the OAuth information in the Authentication section. Entity information should not be provided when generating an OAuth token.
  • Added the invoiceDate, documentDate, invoiceTargetDate, and targetDate fields to the table in the “Minor Version History” section.
  • In the “Update credit memo” and "Update debit memo" operations, noted that currently, Zuora does not support updating tax-inclusive memo items.
  • Removed the redundant OAuth information from the “Other Supported Authentication Schemes” section.
  • Corrected the description of the ratePlanId field in the "Update Subscription" operation.
Zuora Alumni

Re: API Changelog

2017-09-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 September 2017 release, R216.

 

  • Orders - Added a new resource "Orders".
  • Credit Memos - Added a new operation "Get breakdown of credit memo by order".
  • Invoices - Added a new operation "Get breakdown of invoice by order".
  • Payment Methods - Made the following updates:
    • Added a new operation “Verify payment method”.
    • Added the numConsecutiveFailures field to the request body of the “Create payment method” and “Update payment method” operations.
    • Added the NumConsecutiveFailures field to the request body of the “CRUD: Create payment method” operation.
  • Subscriptions - Added the orderNumber field to the response of the “Get subscription by key”, “Get subscriptions by account”, and “Get subscriptions by key and version” operations.

 

Doc Updates

 

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

 

  • In the Action and CRUD operations, corrected the required fields and conditionally required fields, added the missing nested fields, and removed one unsupported CRUD operation.
  • Added the missing cancelledOn and cancelledById fields to the response of the “Create credit memo from charge”, “Create credit memo from invoice”, “Get credit memo”, “Get credit memos”, “Update credit memo”, “Apply credit memo”, “Unapply credit memo”, “Cancel credit memo”, “Post credit memo”, “Query credit memos by account”, “Create debit memo from charge”, “Create debit memo from invoice”, “Get debit memo”, “Get debit memos”, “Update debit memo”, “Cancel debit memo”, and “Post debit memo” operations. 
  • Added the missing autoRenew field to the request body of the “Create subscription” operation.
  • In the "Create billing preview" operation, corrected the type and description of the processingType field.
Zuora Alumni

Re: API Changelog

2017-09-13

 

Incoming Advanced AR Settlement REST API Updates

 

To better standardize the REST APIs for the Advanced AR Settlement feature, Zuora is refractoring the HTTP methods and URLs for some operations. In the October 2017 release (R217), the method and URL updates will be published to the REST API Reference.

For more information, see Refactor of Advanced AR Settlement REST API Methods and URLs.

Zuora Alumni

Re: API Changelog

2017-09-21

 

Doc Updates

 

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

 

  • In the “Amend” operation, corrected the data type and description of the AmendmentIds field in the response.
  • Added Orders objects to the listing of API names in the Zuora Object Model section.
  • In the “CRUD: Create payment” and “CRUD: Update payment method” operations, removed the redundant maxLength and minLength properties from the fields that have the enum property.
Zuora Alumni

Re: API Changelog

 

2017-10-15

 

API Updates

 

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

 

  • Accounts - Added the parentId and salesRep fields to the request body of the "Create account" and "Update account" operations and the response of the "Get account" operation.

The following items are API updates specific to the refactor of Advanced AR Settlement REST APIs.

 

  • Credit Memos - Made the following updates:
    • Removed the “Query credit memos by account” operation.
    • Included the “Create taxation items for credit memo” operation, which was previously in Taxation Items. Now its URL is /v1/creditmemos/{creditMemoId}/taxationitems.
    • Excluded the “Create credit memo from invoice” operation. Now it is located in Invoices.
    • In the “Refund credit memo” operation, changed the URL to /v1/creditmemos/{creditMemoId}/refunds.
    • Changed the HTTP method of the following operations to PUT. Also changed the operationId property in the source YAML file accordingly.
      • Post credit memo
      • Apply credit memo 
      • Unapply credit memo 
      • Cancel credit memo
  • Debit Memos - Made the following updates:
    • Included the “Create taxation items for debit memo” operation, which was previously in Taxation Items. Now its URL is /v1/debitmemos/{debitMemoId}/taxationitems.
    • Excluded the “Create debit memo from invoice” operation. Now it is located in Invoices.
    • Changed the HTTP method of the following operations to PUT. Also changed the operationId property in the source YAML file accordingly.
      • Post debit memo
      • Cancel debit memo 
  • Invoices - Made the following updates:
    • Included the “Create credit memo from invoice” operation, which was previously in Credit Memos. Now its URL is /v1/invoices/{invoiceId}/creditmemos.
    • Included the “Create debit memo from invoice” operation, which was previously in Debit Memos. Now its URL is /v1/invoices/{invoiceId}/debitmemos.
  • Payments - Made the following updates:
    • In the “Transfer payment” operation, changed the HTTP method to PUT and URL to /v1/payments/{paymentId}/transfer, and updated the operationId property in the source YAML file accordingly.
    • In the “Refund payment” operation, changed the URL to /v1/payments/{paymentId}/refunds.
    • Changed the HTTP method of the following operations to PUT. Also changed the operationId property in the source YAML file accordingly.
      • Apply payment
      • Unapply payment
      • Cancel payment
  • Refunds - Changed the HTTP method to PUT for the “Cancel refund” operation, and updated the operationId property in the source YAML file accordingly.
  • Taxation Items - Made the following updates:
    • Excluded the “Create taxation items for credit memo” operation. Now it is located in Credit Memos.
    • Excluded the“Create taxation items for debit memo” operation. Now it is located in Debit Memos.

 

Doc Updates

 

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

 

  • Added user permission reminder and links to Knowledge Center to the description of “Create credit memo from charge”, “Create debit memo from charge”, "Create credit memo from invoice", "Create debit memo from invoice", “Cancel credit memo”, “Cancel debit memo”, “Delete credit memo”, “Delete debit memo”, “Apply credit memo”, “Unapply credit memo”, “Refund credit memo”, “Update credit memo”, and “Update debit memo” operations.
  • In the “Invoice and collect” operation, added the gateway response reason code and error message examples in the operation description.
  • In the “Verify payment method” operation, corrected the URL, updated the operation description, and added the missing data type to the PUTVerifyPaymentMethodResponseType reference object in the source YAML file.
  • In the "Create billing preview" operation, corrected the description of the taxAmount field.
  • Updated descriptions of the "Get breakdown of credit memo by order" operation, the "Get breakdown of invoice by order" operation, and all the operations in the "Orders" resource.
  • Updated the description of the orderNumber field in the “Get subscription by key”, “Get subscriptions by account”, and “Get subscriptions by key and version” operations.
  • Added the Discount Applied Metrics and Taxable Item Snapshot objects to the listing of API names in the Zuora Object Model section.
  • Added descriptions of the "CRUD: Create Export" and "CRUD: Retrieve Export" operations.
  • In the "CRUD: Create Export" operation, added information about data source support in the description of the Query field.
  • In the "Get custom foreign currency exchange rates" operation, updated the description of the currency request parameter.
  • In the source YAML file, corrected the operationId property for the following operations:
    • Create revenue schedule for credit memo item (manual distribution)
    • Create revenue schedule on subscription charge
    • Update payment
    • Get payment part items
Zuora Documentation

Re: API Changelog

2017-10-20

 

Doc Updates

 

  • In the Authentication section, added a note about the permissions of OAuth clients.
  • In the "Describe object" operation, completed the list of data types, improved the response sample, and added a note about undocumented parts of the response.
  • In the “Post usage” operation, added the filename length limit in the operation description.