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!

     

    2020-10-14

  •  

  • API Updates

  •  

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

  •  

    The following API updates are available as of Zuora Billing Release 287, October 2020.

  •  

    • Accounts - In the request body of the "Create account" operation, added the following fields:

      • applyCredit
      • applicationOrder
    • Subscriptions - Made the following updates:

      • In the request body of each of the following operations, added the applyCredit and applicationOrder fields:

        • Create subscription
        • Update subscription
        • Renew subscription
        • Cancel subscription
        • Resume subscription
        • Suspend subscription
      • In the request body of the "CRUD: Update Subscription" operation, enhanced the following fields to support directly updating the subscription trigger dates for Order customers. If you are Zuora's Subscribe and Amend customers, you already have the access to this feature.

        • ContractEffectiveDate
        • ServiceActivationDate
        • ContractAcceptanceDate
    • Orders - In the request body of the "Create order" and "Create order asynchronously" operations, added the following nested fields to the processingOptions field:

      • applyCredit
      • applicationOrder
    • Invoices - Made the following updates:

      • In the request body of each of the following operations, added the taxMode nested field to the the items field:
        • Create credit memo from invoice
        • Create debit memo from invoice
      • In the request body of the "CRUD: Update invoice" operation, changed the behavior of the RegenerateInvoicePDF field. This field is now valid only if you enable the billing document file generation feature.
    • Credit Memos - Made the following updates:

      • In the response body of the "Get credit memo items" operation, added the taxMode nested field to the items field.
      • In the response body of the "Get credit memo item" operation, added the taxMode field.
      • Changed the behavior of the "Create credit memo PDF" operation. This REST API operation now can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled.
    • Debit Memos - Made the following updates:

      • In the response body of the "Get debit memo items" operation, added the taxMode nested field to the items field.
      • In the response body of the "Get debit memo item" operation, added the taxMode field.
      • Changed the behavior of the "Create debit memo PDF" operation. This REST API operation now can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled.

     

  • Doc Updates

     

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

  •  

    • In the response body of the “Get account summary” operation, corrected the type of the invoices > amount field to number.

    • In the "Get charge metrics" operation, corrected the endpoint to /charge-metrics/data/charge-metrics.

    • In the "Get discount allocation details" operation, corrected the endpoint to /charge-metrics/data/charge-metrics-discount-allocation-detail.

    • Made the following updates to state that the duration of a renewal term cannot be greater than 10 years.

      • In the request body of each of the following operations:

        • Create order
        • Create order asynchronously
        • Preview order
        • Preview order asynchronously

        Updated the description for each of the following fields:

        • subscriptions > orderActions > createSubscription > terms > renewalTerms > period
        • subscriptions > orderActions > termsAndConditions > renewalTerms > period
      • In the response body of each of the following operations:

        • Get an order
        • Get order metrics for evergreen subscription

        Updated the description for each of the following fields:

        • order > subscriptions > orderActions > createSubscription > terms > renewalTerms > period
        • order > subscriptions > orderActions > termsAndConditions > renewalTerms > period
      • In the response body of each of the following operations:

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

        Updated the description for each of the following fields:

        • orders > subscriptions > orderActions > createSubscription > terms > renewalTerms > period
        • orders > subscriptions > orderActions > termsAndConditions > renewalTerms > period
  •