This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-04-02   API Updates   This section lists operations and fields that were added, changed, or removed.   The support for creating custom payment runs is generally available. Removed all the Early Adopter enablement notes for the following operations: Create payment run Get payment run summary Get payment run data   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Removed a limitation from the description of the "Create an event trigger" operation. Added the limits of orders allowed on a subscription in the following operations: Create order Create order asynchronously Preview order Preview order asynchronously ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-03-26   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the response body of the "Amend" action, noted in the description of the   results   >   InvoiceDatas   field that this array contains only one invoice. In the request body of the "Update payment method" operation, updated the description for the   securityCode   field. In the description of the “Get invoice files” operation, clarified the behavior of this operation.   ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-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 297, March 2021.   Workflows   - Added an operation called "Rerun a task by ID". Custom Object Jobs   - Added a resource called "Custom Object Jobs", with the following operations: Submit custom object bulk job Get all custom object bulk jobs Get custom object bulk job Upload file for custom object bulk job Get all errors for a custom object bulk job Subscriptions   - In the request body of the "Update subscription custom fields of a specified subscription version" operation, added the   ratePlans   >   charges   >   chargeId   field. Orders   - Previously, a suspended subscription could not be resumed on a specific date through the "Create order" operation. This issue has now been resolved. The data format of the   subscriptions   >   orderActions   >   resume   >   resumeSpecificDate   field has been corrected from   string<dateTime>   to   string<date>   in the request body of the "Create order" operation.   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: Get rate plan charge" operation, added the missing   RolloverBalance   field. In the query parameter lists of the "Get callout notification histories" and "Get email notification histories" operations, added a note in the description of each of the following parameters: objectId failedOnly eventCategory In the request body of the "Update subscription custom fields of a specified subscription version" operation, updated the description for the   ratePlans   >   charges   >   chargeNumber   field.   ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-03-11   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 296, March 2021.   The Invoice Settlement feature is generally available as of this release. Changed all the Limited Availability notes to General Availability notes for: All the operations specific to Invoice Settlement All the fields related to Invoice Settlement in other operations   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the response body of each of the "Get a workflow by ID" and "Run a workflow" operations, corrected the statuses and added the description for each status. Added a note in the description of the "Event Triggers" section. In the "Notifications" section, added references to Communication Profiles Settings pages in the Knowledge Center. Added a note in the description of each of the following operations: Create a notification definition Query notification definitions Update a notification definition Get a notification definition Delete a notification definition Create an email template Query email templates Update an email template Get an email template Delete an email template   ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-03-04   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 295, March 2021.   Payment Runs   - Made the following updates to support the feature for creating custom payment runs. In the request body of the "Create payment run" operation, added the   data   field. This field is only available if the feature for creating custom payment runs is enabled. In the description of the "Create payment run" operation, added the behavior description for creating custom payment runs. In the response body of the "Get payment run summary" operation, added the following fields: numberOfInputData numberOfProcessedInputData numberOfErrorInputData Added an operation called "Get payment run data" to retrieve payment run data and the processing result with details.   ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-02-25   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 294, February 2021.   Billing Preview Run   - In the description of the "Create billing preview run" operation, changed the maximum number of concurrent billing preview runs to 20.   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, added a note to the description of the   readDeleted   field.   ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-02-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 293, February 2021.   Credit Memos   - Made the following updates: In the description of the "Apply credit memo" operation, changed the limit on applying credit memos, and added the limit to the following fields in the request body: invoices invoices   >   items debitMemos debitMemos   >   items In the description of the "Refund credit memo" operation, added a limit on refunding credit memos. In the description of the "Unapply credit memo" operation, changed the limit on unapplying credit memos, and added the limit to the following fields in the request body: invoices invoices   >   items debitMemos debitMemos   >   items Payments   - Made the following updates: In the request body of the "Create payment" operation, changed the limit on creating payments, and added the limit to the following fields in the request body: invoices invoices   >   items debitMemos debitMemos   >   items In the description of the "Apply payment" operation, changed the limit on applying payments, and added the limit to the following fields in the request body: invoices invoices   >   items debitMemos debitMemos   >   items In the description of the "Unapply payment" operation, added the limit on unapplying payments, and added the limit to the following fields in the request body: invoices invoices   >   items debitMemos debitMemos   >   items Actions   - Made the following updates: In the request body of the "Subscribe" action, enhanced the   subscribes   >   SubscribeOptions   >   ProcessPayments   field for payment processing retries. In the request body of the "Amend" action, enhanced the   requests   >   AmendOptions   >   ProcessPayments   field for payment processing retries. ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-02-09   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 292, February 2021.   Data Queries   - Made the following updates: Added the   sourceData   field to the request schema of the "Submit data query" operation. Added the following RateLimit response headers to all the responses of each and every operation: RateLimit-Limit RateLimit-Remaining RateLimit-Reset Payments   - Made the following updates: In the request body of the "Create payment" operation, added the   gatewayOptions   field and its nested fields. In the response schema of the "Refund payment" operation, changed the error category code   60   to   50   and optimized the corresponding error message for the errors occurring while issuing external refunds with the default reason code. Credit Memos   - In the response schema of the "Refund credit memo" operation, changed the error category code   60   to   50   and optimized the corresponding error message for the errors occurring while issuing external refunds with the default reason code.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the “Update account” operation, clarified the update details of the Bill To and Sold To contacts in the same customer account. ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-01-29   API Updates   This section lists operations and fields that were added, changed, or removed.   As of Zuora Billing Release 288, November 2020, the legacy endpoint   /apps/api/file/{file-id}   can no longer be used to retrieve files. Instead, you should use   Get files   to retrieve files. Note:   Responses from "Get files" contain character encoding information in the   Content-Type   header. For example,   Content-Type: application/pdf;charset=UTF-8 . Responses from   /apps/api/file/{file-id}   did not contain character encoding information in the   Content-Type   header. For example,   Content-Type: application/pdf .   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the "Get files" operation, added information about the response content type. ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-01-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 291, January 2021.   Payments   - Made the following updates: Changed the behavior of each of the following operations. When the Invoice Settlement feature is enabled, you can now use these operations to create or update payments. CRUD: Create payment CRUD: Update payment In the request body of the "CRUD: Create payment" operation, changed the behavior of the following fields: AppliedCreditBalanceAmount Status In the request body of the "CRUD: Update payment" operation, changed the behavior of the   Status   field. In the response body of the "CRUD: Get payment" operation, changed the behavior of the following fields: AppliedCreditBalanceAmount Status Refunds   - Made the following updates: Changed the behavior of each of the following operations. When the Invoice Settlement feature is enabled, you can now use these operation to refund payments. CRUD: Create refund CRUD: Update refund In the request body of the "CRUD: Create refund" operation, changed the behavior of the   SourceType   field.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Subscribe" action, updated the description for the action and the description of the   subscribes   >   SubscriptionData   >   RatePlanData   >   RatePlanChargeData   >   RatePlanCharge   >   TriggerEvent   field in the request body to indicate when previewing invoices with this action, the corresponding Contract Effective, Service Activation, or Customer Acceptance date is required if the subscription contains a charge with its trigger event being set as   ContractEffectiveDate ,   ServiceActivationDate , or   CustomerAcceptanceDate . ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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!   2021-01-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 290, January 2021.   Actions   - Made the following updates: In the request body of the "Amend" action, added the following nested fields to the   AmendOptions   field: ApplicationOrder ApplyCredit In the response body of the "Amend" action, added the following fields: CreditMemoDatas   field and its nested fields CreditMemoId In the request body of the "Subscribe" action, added the following nested fields to the   subscribes   >   SubscribeOptions   field: ApplicationOrder ApplyCredit In the response body of the "Subscribe" action, added the following fields: CreditMemoData   field and its nested fields CreditMemoId CreditMemoNumber CreditMemoResult   field and its nested fields Payments   - In the response body of the "CRUD: Get payment" operations, added the following fields: AppliedAmount UnappliedAmount Invoices   - In the response body of the "Write off invoice" operation, added the support for NetSuite custom fields. Exports   - Explained the newly enforced Data Source Export limits in the descritpion of the “CRUD: Create Export” operation. Notifications   - Added the following operations: Delete notification histories for an account Get a notification history deletion task Orders   - Made the following updates to add the   applyDiscountTo   and   discountLevel   fields to the Update product order action in all the Orders APIs. In the request body of each of the following operations: Create order Create order asynchronously Preview order Preview order asynchronously Added the following fields: subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   discount   >   applyDiscountTo subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   discount   >   discountLevel In the response body of each of the following operations: Get an order Get order metrics for evergreen subscription Added the following fields: order   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   discount   >   applyDiscountTo order   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   discount   >   applyDiscountTo 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 Added the following fields: orders   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   discount   >   applyDiscountTo orders   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   discount   >   applyDiscountTo Subscriptions   - Made the following updates for a new field on the Subscription object. In the response body of each of the following operations, added the   revision   field. Get subscriptions by key and version Get subscriptions by key In the response body of the "Get subscriptions by account" operation, added the   revision   field in the   subscriptions   nested field. In the "CRUD: Retrieve Subscription" operation: Added the   X-Zuora-WSDL-Version   request header parameter. Added the   Revision   field in the response body.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Payment Methods" section, added the following missing operations: Update payment method Get payment method Removed the incorrect   Id   path parameter from the request sample in the "CRUD: Update Subscription" operation. ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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-12-18   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 289, December 2020.   Invoices   - Changed the behavior of the following operations. You can now write off or reverse an invoice if it contains at most 2,000 items. The limit was 750 previously. Reverse invoice Write off invoice   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the response body of the following operations, corrected the enum value   completed   to   complete   for the   taxStatus   field: Create credit memo from charge Create credit memo from invoice Get credit memo Update credit memo Apply credit memo Unapply credit memo Cancel credit memo Post credit memo Unpost credit memo Create debit memo from charge Create debit memo from invoice Get debit memo Update debit memo Cancel debit memo Post debit memo Unpost debit memo In the response body of the "Get credit memos" operation, corrected the enum value   completed   to   complete   for the   creditmemos   >   taxStatus   field. In the response body of the "Get debit memos" operation, corrected the enum value   completed   to   complete   for the   debitmemos   >   taxStatus   field.  ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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-12-10   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 289, December 2020.   Orders   - Made the following updates to remove the 10-year limitation on the duration of subscription terms. Previously, the duration of the initial term or renewal term of a subscription could not 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 Removed the 10-year limitation in each of the following fields: subscriptions   >   orderActions   >   createSubscription   >   terms   >   initialTerm   >   period subscriptions   >   orderActions   >   createSubscription   >   terms   >   renewalTerms   >   period subscriptions   >   orderActions   >   termsAndConditions   >   lastTerm   >   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 Removed the 10-year limitation in each of the following fields: order   >   subscriptions   >   orderActions   >   createSubscription   >   terms   >   initialTerm   >   period order   >   subscriptions   >   orderActions   >   createSubscription   >   terms   >   renewalTerms   >   period order   >   subscriptions   >   orderActions   >   termsAndConditions   >   initialTerm   >   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 Removed the 10-year limitation in each of the following fields: orders   >   subscriptions   >   orderActions   >   createSubscription   >   terms   >   initialTerm   >   period orders   >   subscriptions   >   orderActions   >   createSubscription   >   terms   >   renewalTerms   >   period orders   >   subscriptions   >   orderActions   >   termsAndConditions   >   initialTerm   >   period orders   >   subscriptions   >   orderActions   >   termsAndConditions   >   renewalTerms   >   period Debit Memos   - Made the following updates: Added an operation called "Collect existing posted debit memo". In the request body of the "Create debit memo from charge" operation, added the   autoPost   field. Credit Memos   - Made the following updates: In the request body of the "Create credit memo from charge" operation, added the   autoPost   field. In the request body of the "Refund credit memo" operation, added the following fields: SoftDescriptor SoftDescriptorPhone Invoices   - In the request body of each of the following operations, added the   autoPost   field: Create credit memo from invoice Create debit memo from invoice Payments   - In the request body of each of the "Create payment" and "Refund payment" operations, added the following fields: SoftDescriptor SoftDescriptorPhone Attachments   - Made the following updates: Changed the behaviors of the following operations. You can now use these operations to manage attachments for credit memos and debit memos: Add attachments View attachments list View attachments Edit attachments Delete attachments In the "Add attachments" operation, added the following enum values to the   associatedObjectType   query parameter and changed the behavior of the   associatedObjectKey   query parameter accordingly: CreditMemo DebitMemo In the "View attachments" operation, added the following enum values to the   object-type   query parameter and changed the behavior of the   object-key   query parameter accordingly: creditmemo debitmemo   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Corrected the description of the "Credit Card" section in the "Create payment method" operation. ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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-12-04   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the "List all settings" operation, added references to the newly added Settings API tutorials in the Knowledge Center. ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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-11-27   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of each of the following operations, added more details about the  ProductRatePlanChargeTierData  >  ProductRatePlanChargeTier  field: CRUD: Create product rate plan charge CRUD: Update product rate plan charge     ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. The API changes are compliant with   Zuora API Policy. 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-11-13   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Updated the request sample of the "Create custom object definition" operation. Made the following updates to the “Create credit memo from invoice” and “Create debit memo from invoice” operations: In the request body of each operation, added more details about the   invoiceId   field and clarified the purpose of this field. Corrected the  items  >  taxMode  field  in the request sample of each operation.   ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. 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-11-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 288, November 2020.   Orders   - Made the following updates: In the request body of each of the following operations, added the   quote   field and its nested fields to the   subscriptions   field: Create order Create order asynchronously Preview order Preview order asynchronously In the response body of each of the following operations, added the   quote   field and its nested fields to the   order   >   subscriptions   field: Get an order Get order metrics for evergreen subscription In the response body of each of the following operations, added the   quote   field and its nested fields to the   orders   >   subscriptions   field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner In the request body of the "Update order custom fields" operation, added the   orderActionId   nested field to the   subscriptions   >   orderActions   field. In the response body of each of the following operations, added the   id   nested field to the   order   >   subscriptions   >   orderActions   field: Get an order Get order metrics for evergreen subscription In the response body of each of the following operations, added the   id   nested field to the   orders   >   subscriptions   >   orderActions   field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Invoices   - Made the following updates: In the response body of the "Get invoice items" operation, added the   unitPrice   nested field to the   invoiceItems   field. In the request body of the following operations, added a limit to the   items   field: Create credit memo from invoice Create debit memo from invoice Credit Memos   - In the request body of the "Create credit memo from charge" operation, added a limit to the   charges   field. Debit Memos   - In the request body of the "Create debit memo from charge" operation, added a limit to the   charges   field. Billing Preview Runs   - In the response body of the "Get billing preview run" operation, changed the value of the   resultFileUrl   field and updated the response sample correspondingly. Mass Updater   - In the response body of the "Get mass action result" operation, changed the value of the   outputURL   field and updated the response sample correspondingly. Credit Balance Adjustments   - In the request body of the "CRUD: Create credit balance adjustment" operation, added the   AdjustmentDate   field. Refunds   - In the request body of the "CRUD: Create refund" operation, changed the behavior of the   RefundDate   field.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the source YAML file, added the   QuoteObjectFields   reference object. This change affects the following operations: 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: Billing. 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-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: Create credit balance adjustment" operation, corrected the description of the following fields: SourceTransactionId SourceTransactionNumber ... View more

This changelog outlines the latest REST API updates and documentation updates in the   API Reference: Billing. 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-23   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, added a note to the description of the  encryptionKey  field. Changed the title of the API Reference from "Zuora API Reference" to "API Reference: Billing". ... 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-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   ... 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-09-30   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of September 30, 2020.   Charge Metrics   - Added a resource called "Charge Metrics", with the following operations: Get charge metrics Get discount allocation details   The High Water Mark Volume Pricing, High Water Mark Tiered Pricing, Pre-Rated Per Unit Pricing, Pre-Rated Pricing, and Multi-Attribute Pricing charge models are now generally available as of September 30, 2020. The following updates are specific to these charge models.   Subscriptions   - Made the following updates In the request body of each of the following operations, updated the description of the   subscribeToRatePlans   >   chargeOverrides   >   chargeModelConfiguration   field and its nested fields: Preview subscription Create subscription In the request body of the "Update subscription" operations, updated the description of each of the following fields and their nested fields: add   >   chargeOverrides   >   chargeModelConfiguration update   >   chargeUpdateDetails   >   chargeModelConfiguration In response body of the "Get subscriptions by account" operation, updated the description of the   subscriptions   >   ratePlans   >   ratePlanCharges   >   chargeModelConfiguration   field and its nested fields. In response body of the following operations, updated the description of the   ratePlans   >   ratePlanCharges   >   chargeModelConfiguration   field and its nested fields: Get subscriptions by key Get subscriptions by key and version Orders   - Made the following updates: In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, updated the description of each of the following fields and their nested fields: subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   chargeModelData subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   chargeModelData subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   chargeModelData In the response body of each of the following operations, updated the description of the   order   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   chargeModelData   field and its nested fields: Get an order Get order metrics for evergreen subscription In the response body of the following operations, updated the description of the   orders   >   subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   chargeModelData   field and its nested fields: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Product Rate Plan Charges   - Made the following updates: In the request body of the "CRUD: Create product rate plan charge" and "CRUD: Update product rate plan charge" operations, updated the description of each of the following enum values for the   ChargeModel   field: MultiAttributePricing PreratedPerUnit PreratedPricing HighWaterMarkVolumePricing HighWaterMarkTieredPricing In the request body of each of the following operations, updated the description of the   ChargeModelConfiguration   field and its nested fields: CRUD: Create product rate plan charge CRUD: Update product rate plan charge Product Rate Plans   - In the response body of the “Get product rate plans” operation, made the following updates: Updated the description of each of the following fields: productRatePlans   >   productRatePlanCharges   >   pricingSummary formula Updated the description of each of the following enum values for the   productRatePlans   >   productRatePlanCharges   >   model   field: MultiAttributePricing PreratedPerUnit PreratedPricing HighWatermarkVolumePricing HighWatermarkTieredPricing   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 a notification definition” operation, updated the description of the   eventTypeNamespace   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-09-25   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of September 25, 2020.   Orders   - Made the following updates: In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, added the   tiers   field and its nested fields to the following fields: subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   chargeModelData subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   chargeModelData subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   chargeModelData In the response body of the following operations, added the   tiers   field and its nested fields to the   order   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   chargeModelData   field: Get an order Get order metrics for evergreen subscription In the response body of the following operations, added the   tiers   field and its nested fields to the   orders   >   subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   chargeModelData   field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Product Rate Plan Charges   - Made the following updates: In the following operations, added the   X-Zuora-WSDL-Version   request header parameter: CRUD: Create product rate plan charge CRUD: Update product rate plan charge In the request body of the "CRUD: Create product rate plan charge" and "CRUD: Update product rate plan charge" operations, added the following enum values to the   ChargeModel   field: MultiAttributePricing PreratedPerUnit PreratedPricing HighWaterMarkVolumePricing HighWaterMarkTieredPricing In the request body of each of the following operations, added the   ChargeModelConfiguration   field and its nested fields. CRUD: Create product rate plan charge CRUD: Update product rate plan charge Product Rate Plans   - In the response body of the "Get product rate plans" operation, added the following nested fields to the   productRatePlans   >   productRatePlanCharges   field: chargeModelConfiguration formula   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Access to the API" section, added the base URLs for REST endpoints of the following enviroments: US Cloud Production US Cloud API Sandbox US Central Sandbox EU Central Sandbox In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, corrected the name of the   ChargeModelConfiguration   nested field to   chargeModelConfiguration   in the following fields: subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   chargeModelData subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   chargeModelData subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   chargeModelData In the response body of the following operations, corrected the name of the   ChargeModelConfiguration   nested field to   chargeModelConfiguration   for the   order   >   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   chargeModelData   field: Get an order Get order metrics for evergreen subscription In the response body of the following operations, corrected the name of the   ChargeModelConfiguration   nested field to   chargeModelConfiguration   for the   orders   >   subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   chargeModelData   field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, updated the following fields from optional to required: subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   oneTimeTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   oneTimeVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   recurringTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   recurringVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   usageTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   usageTieredWithOverage   >   tiers   >   priceFormat subscriptions   >   orderActions   >   addProduct   >   chargeOverrides   >   pricing   >   usageVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   oneTimeTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   oneTimeVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   recurringTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   recurringVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   usageTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   usageTieredWithOverage   >   tiers   >   priceFormat subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   pricing   >   usageVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   oneTimeTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   oneTimeVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   recurringTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   recurringVolume   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   usageTiered   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   usageTieredWithOverage   >   tiers   >   priceFormat subscriptions   >   orderActions   >   createSubscription   >   subscribeToRatePlans   >   chargeOverrides   >   pricing   >   usageVolume   >   tiers   >   priceFormat ... 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-09-17     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 Apple Pay payment method" operation, added the following missing fields: mitProfileAction mitConsentAgreementSrc mitProfileType In the request body of the "CRUD: Get account" operation, corrected the field name of the   CommunicationProfileId   field. In the request body of the "Cancel subscription" operation, added the missing   contractEffectiveDate   field. Changed the name of the Zuora Object Model section to Zuora Billing Object Model, and updated related reference links. In the request body of the "CRUD: Create payment method" operation, corrected the description of the   SkipValidation   field. In the request body of the "Create summary journal entry" operation, updated the description of the   segmentName   field. In the descriptions of the Create action and the following operations, added links to related use cases in the API Guides. Create a notification definition Create credit memo from invoice Create credit memo from charge Create order CRUD: Update contact CRUD: Update payment method Delete payment method Get credit memo Get credit memos Get invoices Get product catalog Get product rate plans Post usage Preview order Refund payment Refund credit memo Update account Removed the Charge Metrics operations that are not supported yet. ... 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-09-10   Doc Updates   This version is a correction to the previous 2020-09-08 version. In the 2020-09-08 version, some updates related to Charge Metrics, Ramps, and Orders general availability were missing from the API Reference. The 2020-09-10 version is a fix to this. ... View more

2020-09-08   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 285, September 2020.   Custom Object Definitions   - Made the following updates: In the request body and response body of the "Update custom object definition" operation, added the  filterable  nested field to the   action   >   field   field. In the description of the "Create custom object definition" operation, explained the enhancement of this operation.   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, updated the description of the   SkipValidation   field. In the Zuora Object Model section, updated the diagram to encompass the Orders feature and Invoice Settlement feature. ... View more

2020-08-31   API Updates   This section lists operations and fields that were added, changed, or removed.   Orders is now generally available as of Zuora Billing Release 284, August 31, 2020. The following API updates are available for the release.   Note: The API updates described below are currently available in the Sandbox environment only. They will become available in the Production environment on September 10.   Ramps   - Added a resource called "Ramps", with the following operations: Get ramp by ramp number Get ramp metrics by ramp number Get ramp by subscription key Get ramp metrics by subscription key Get ramp metrics by order number Orders   - Made the following updates: In the request body of each of the following operations, added the   ramp   field and its nested fields to the   subscriptions   field. Create order Create order asynchronously Preview order Preview order asynchronously In the request body of each of the following operations, added the   RampMetrics   and   RampDeltaMetrics   enum values to the   previewOptions   >   previewTypes   field. Preview order Preview order asynchronously In the response body of the "Create order" operation, added the   ramps   field and its nested fields. In the response body of the "Preview order" operations, added the   rampMetrics   and its nested fields to the   previewResult   field. In the response body of each of the following operations, added the   ramp   field and its nested fields to the   order   >   subscriptions   field: Get an order Get order metrics for evergreen subscription In the response body of each of the following operations, added the   ramp   field and its nested fields to the   orders   >   subscriptions   field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner In the request body of the "Preview order" operation, made the following updates: Added the   NumberOfPeriods   enum value to the   previewOptions   >   previewThruType   field. Added the   previewNumberOfPeriods   field to the   previewOptions   nested field. In the response body of each of the following operations: Get an order Get all orders Get orders for subscription owner Get orders for subscription number Get orders for invoice owner deprecated the following fields for any new customers who onboard on   Orders   or   Orders Harmonization. Existing Orders customers who have these fields will continue to be supported. order(s)   >   subscriptions   >   orderActions   >   orderItems order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   elp order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   quantity   >   orderItemId order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   quantity   >   generatedReason order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   mrr   >   orderItemId order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   mrr   >   generatedReason order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   tcb   >   orderItemId order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   tcb   >   generatedReason order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   tcv   >   orderItemId order(s)   >   subscriptions   >   orderActions   >   orderMetrics   >   tcv   >   generatedReason In the response body of the "Preview order" operation, deprecated the following fields for any new customers who onboard on   Orders   or   Orders Harmonization. Existing Orders customers who have these fields will continue to be supported. previewResult   >   orderMetrics   >   orderActions   >   orderItems previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   elp previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   quantity   >   orderItemId previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   quantity   >   generatedReason previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   mrr   >   orderItemId previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   mrr   >   generatedReason previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   tcb   >   orderItemId previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   tcb   >   generatedReason previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   tcv   >   orderItemId previewResult   >   orderMetrics   >   orderActions   >   orderMetrics   >   tcv   >   generatedReason   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In all the   Orders   operations, updated the notes to inform that Orders is now generally available. ... View more

2020-08-28   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of August 28, 2020.   Charge Metrics   - Added a resource called "Charge Metrics", with the following operations: Get charge metrics Get discount allocation details   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Error Handling" section, updated the description to reflect the error handling behavior for GET and DELETE requests. ... View more