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-06-28   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In  the request body of the "Update taxation item" operation, updated the following fields from required to optional: jurisdiction name taxAmount taxRate taxRateType . ... View more

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-06-24   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the "Write off invoice" operation, clarified the restrictions on invoice write-off. ... View more

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-06-12   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   I n the request body of the “Update or delete custom object records as a batch” operation, added the missing   type   property for the   action   >   ids   field. In the request sample of the "Create custom object definition" operation, added the   filterable   field with its value. In the response sample of the "Get all custom object definitions" operation, added the   definitions   >   person   >   schema   >   filterable   field with its value. In the response sample of the following operations, added the   schema   >   filterable   field with its value: Create custom object definition Get custom object definition In the request body of the "Subscribe" action, added the missing description for the   subscribes   >   SubscribeOptions   >   SubscribeInvoiceProcessingOptions   >   InvoiceProcessingScope   field. ... View more

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-06-04   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the “Submit data query” operation, updated the description of the enum value  JSON  for the  outputFormat  field . ... View more

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-05-29   Recent Error Code Updates   This section summarizes the error category code updates that have been made since May.   The following changes are available since Zuora Billing Release 275:   Deprecated the   00   error category code because it was not informative to API users. The previous   00   error category code was reclassified into other error category codes based on the actual error type. Redefined the   99  error category code as the integration error. Previously, it was defined as the extension error.   The following changes are available since Zuora Billing Release 276:   Added the   45   error category code. Migrated some errors of the   60   error category to other error categories based on the specific error type.   Previously, we did not fully document the changes made to the error codes that are returned within the response. Going forward, we will include the error code changes in the API Changelog to improve our API documentation. For more information about Billing error codes, see   Error Handling.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the error handling information to the descriptions of the "Custom Object Definitions" and "Custom Object Records" sections. Added the error code information to the description of the   details   >   code   field in the 400 and 500 response schema of the following operations: Create custom object records Update or delete custom object records as a batch ... View more

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-05-21   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 277, May 2020.   Custom Object Records   - Updated the response schemas and samples for each of the following operations: Create custom object records Update or delete custom object records as a batch   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Removed the Eearly Adopter disclaimer from all the operations of "Custom Object Definitions" and "Custom Object Records". In the request body of the "CRUD: Create product" and "CRUD: Update product" operations, removed the character limit information from the description of each of the following fields: EffectiveEndDate EffectiveStartDate In the response body of the "CRUD: Get product" operation, removed the character limit information from the description of each of the following fields: EffectiveEndDate EffectiveStartDate UpdatedDate ... View more

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-05-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 276, May 2020.   Error Category   - In the error category table, added   45   as a new error category code for the Billing REST API.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the following headers for all operations that did not have these headers: Zuora-Track-Id   header in the request Zuora-Track-Id   header in each response Zuora-Request-Id   header in each response Added the following missing operations: CRUD: Create Feature CRUD: Update Feature In the request body of the following operations, added the missing   ActiveCurrencies   field: CRUD: Create product rate plan CRUD: Update product rate plan In the response body of the "CRUD: Get product rate plan" operation, added the missing   ActiveCurrencies   field. Removed the note about how to access the Suspend and Resume feature from the following operations: Suspend subscription Resume subscription CRUD: Get amendment CRUD: Update amendment Amend Create order Create order asynchronously Preview order Preview order asynchronously Get an order Get order metrics for evergreen subscription Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner ... View more

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-05-07   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 275, May 2020.   Orders   - In the request body of the "Creat order" operation, changed the behavior of the   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   effectiveDate   >   specificTriggerDate   field. This behavior change is available only when the Pending order feature is not enabled. See the description of the   specificTriggerDate   field to find out details about the latest behavior. Credit Memos   - In the request body of the "Refund credit memo" operation, added the   gatewayOptions   field. Payments   - In the request body of the "Refund payment" operation, added the   gatewayOptions   field. Invoices   - Changed the behavior of the following operations. You can only write off or reverse an invoice if it contains at most 750 items. Reverse invoice Write off invoice   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the   Error Handling   section to document general information about handling error codes returned by Zuora Billing REST API with an endpoint starting with   /v1   ( except  Actions  and  CRUD operations). Added a limitation to the description of the “Create an event trigger” operation. In the source YAML file, duplicated the   CreateOrderTriggerParams   reference object as a new reference object called   CreateOrderUpdateProductTriggerParams , which is used in the request body of the “Create order” operation. ... View more

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-04-30   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the "CRUD: Update payment" operation, removed the unsupported   Comment   field. In the request body of the "Create account" operation, made the following updates: Updated the   creditCard   field description to clarify that this field has been deprecated, and is currently available only for backward compatibility. In the   paymentMethod   field, made the following updates: Added the following missing supported payment method types to the   type   nested field: PayPalEC PayPalNativeEC PayPalAdaptive SEPA Betalingsservice Autogiro Bacs Added the following missing nested fields: BAID checkDuplicated preapprovalKey mitProfileAction mitProfileType mitProfileAgreedOn mitConsentAgreementSrc mitConsentAgreementRef mitNetworkTransactionId IBAN businessIdentificationCode accountNumber identityNumber bankCode branchCode makeDefault authGateway accountKey Made the following updates for the General Available release of the Suspend and Resume feature: Updated the description for each of the following operations: Suspend subscription Resume subscription In the response body of the "CRUD: Get amendment" operation, updated the description of the   Type   field. In the request body of the "CRUD: Update amendment" operation, updated the description of the   Type   field. In the request body of the "Amend" action, updated the description for each of the following fields: requests   >   Amendments   >   SuspendDate requests   >   Amendments   >   ResumeDate requests   >   Amendments   >   Type 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   >   suspend subscriptions   >   orderActions   >   resume 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   >   suspend order   >   subscriptions   >   orderActions   >   resume 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   >   suspend orders   >   subscriptions   >   orderActions   >   resume In the request body of each of the following operations: Create order Create order asynchronously Corrected the description for each of the following fields: newAccount   >   taxInfo   >   exemptStatus newAccount   >   taxInfo   >   exemptCertificateId newAccount   >   taxInfo   >   exemptCertificateType newAccount   >   taxInfo   >   exemptEffectiveDate newAccount   >   taxInfo   >   exemptExpirationDate newAccount   >   taxInfo   >   exemptDescription subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the request body of each of the following operations: Preview order Preview order asynchronously Corrected the description for each of the following fields: previewAccountInfo   >   taxInfo   >   exemptStatus previewAccountInfo   >   taxInfo   >   exemptCertificateId previewAccountInfo   >   taxInfo   >   exemptCertificateType previewAccountInfo   >   taxInfo   >   exemptEffectiveDate previewAccountInfo   >   taxInfo   >   exemptExpirationDate previewAccountInfo   >   taxInfo   >   exemptDescription subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the response body of each of the following operations: Get an order Get order metrics for evergreen subscription Corrected the description for each of the following fields: order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription 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 Corrected the description for each of the following fields: orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the descritpion of the "Create order" operation, updated the note about the operation rollback. ... View more

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-04-23   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request and response samples of the “Create a notification definition” operation, replaced   "AccountNumber": "<Account.Number>"   with   "AccountNumber": "<Account.AccountNumber>" Added limitations to the description of the “Create an event trigger” operation. In the request body of the "Create payment method" operation, removed the   enum   property from the   type   field and updated the field description. In the "RevPro Integration" section, made the following updates: Renamed this section as "Zuora Revenue Integration". Updated the description of this section. Renamed the "Update an accounting code" operation to "Update Zuora Revenue accounting code" to be more accurate. Updated the description of the "Update Zuora Revenue accounting code" operation. ... View more

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-04-17   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 274, April 2020.   Data Queries - In the response body of each of the following operations, added the createdBy nested field to the data field: Submit data query Get data query jobs Get data query job Cancel data query job   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Settings" section, removed all the "In Development" notes. ... View more

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-04-02   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the following operations, noted that it is best practice to set the  zuora-version  parameter to  211.0  or later if you have Invoice Settlement enabled; otherwise, an error occurs. Create subscription Update subscription Renew subscription Cancel subscription Resume subscription Suspend subscription ... View more

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-03-27   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Clarified the limitations in the description of the “Write off invoice” operation. ... View more

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-03-19   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 272, March 2020.   Invoices   - In the request body of the “Update invoices” operation, added the   invoiceDate   nested field to the   invoices   field. Bill Runs   - In the request body of the “CRUD: Post or Cancel bill run” operation, added the   InvoiceDate   field. Sequence Sets   - Made the following updates: Added support for configuring and managing prefixes and starting numbers for payments and refunds in sequence sets. In the request body of the "Create sequence set" operation, added the following nested fields to the   sequenceSets   field: payment   and its nested fields refund   and its nested fields In the request body of the "Update sequence set" operation, added the following fields: payment   and its nested fields refund   and its nested fields In the response body of the “Create sequence set” operation and the response body of the “Get sequence sets” operation, added the following nested fields to the   sequenceSets   field: payment   and its nested fields refund   and its nested fields In the response body of the "Get sequence set" operation, added the following fields: payment   and its nested fields refund   and its nested fields Orders   - Removed the "Get rated result for order" operation. ... View more

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-03-12   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 271, March 2020.   Custom Object Records - Added the ids query parameter to the "Query custom object records" operation. Orders - Made the following updates: In the request bodies of the "Create order" and "Create order asynchronously" operations, added the paymentMethod nested field to the following fields: newAccount subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount In the request bodies of the following operations, added the paymentMethod nested field to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field: Preview order Preview order asynchronously In the response bodies of the following operations, added the paymentMethod nested field to the order > subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field: Get an order Get order metrics for evergreen subscription In the response bodies of the following operations, added the paymentMethod nested field to the orders > subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Amend" action, made the following updates: In the description of the action, clarified that the action cannot modify the custom fields on the Subscription object. In the request body, corrected the possible value of the requests > Amendments > Code field. ... View more

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-03-05   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 270, March 2020.   Accounts   - Added the   paymentMethod   field to the request body of the "Create account" operation. Payment Methods   - In the "Create payment method" operation, made the following updates: Added the following fields to the request body: IBAN businessIdentificationCode accountNumber identityNumber bankCode branchCode Added the following enum values to the   type   field: SEPA Betalingsservice Autogiro Bacs Updated the description of the operation based on the preceding field changes. ... View more

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-02-27   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the "CRUD: Create payment method" operation, removed the following unsupported enum values from the Type field. Cash Check ApplePay WireTransfer Other ... View more

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-02-19   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the "Create payment method" operation, added the missing checkDuplicated field. ... View more