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!   2019-12-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 263, December 2019.   Orders   - Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations. Credit Memos   - Made the following updates: Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations. Changed the behavior of the “Create credit memo from charge” operation. When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. Debit Memos   - Changed the behavior of the “Create debit memo from charge” operation. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference. In the response body of the "Subscribe" action, corrected the nested fields of the   InvoiceData   >   InvoiceItem   field. In the response body of the "Amend" action, corrected the nested fields of the   results   >   InvoiceDatas   >   InvoiceItem   field. In the source YAML file, duplicated the   InvoiceItem   reference object as the following new reference objects: A reference object called   ActionSubscribeInvoiceItem   that is used in the response body of the “Subscribe” action. A reference object called   ActionAmendInvoiceItem   that is used in the response body of the “Amend” action. In the source YAML file, duplicated the   InvoiceData   reference object as the following new reference objects: A reference object called   ActionSubscribeInvoiceData   that is used in the response body of the “Subscribe” action. A reference object called   ActionAmendInvoiceData   that is used in the response body of the “Amend” action. In the description of the “Query custom object records” operation, added the limitations of this operation. In the description of the “List all settings” operation, added links pointing to the tutorials of Settings API in the Knowledge Center. ... 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!   2019-12-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 263, December 2019.   Orders   - Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations. Credit Memos   - Made the following updates: Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations. Changed the behavior of the “Create credit memo from charge” operation. When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency. Debit Memos   - Changed the behavior of the “Create debit memo from charge” operation. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference. In the response body of the "Subscribe" action, corrected the nested fields of the   InvoiceData   >   InvoiceItem   field. In the response body of the "Amend" action, corrected the nested fields of the   results   >   InvoiceDatas   >   InvoiceItem   field. In the response body of the "Amend" action, corrected the   InvoiceDatas   >   InvoiceItem   nested fields. In the source YAML file, duplicated the   InvoiceItem   reference object as the following new reference objects: A reference object called   ActionSubscribeInvoiceItem   that is used in the response body of the “Subscribe” action. A reference object called   ActionAmendInvoiceItem   that is used in the response body of the “Amend” action. In the source YAML file, duplicated the   InvoiceData   reference object as the following new reference objects: A reference object called   ActionSubscribeInvoiceData   that is used in the response body of the “Subscribe” action. A reference object called   ActionAmendInvoiceData   that is used in the response body of the “Amend” action. In the description of the “Query custom object records” operation, added the limitations of this operation. In the description of the “List all settings” operation, added links pointing to the tutorials of Settings API in the Knowledge Center. ... 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!   2019-11-21   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 custom object definition” operation Removed the   type   field Updated the description of the   relationships   >   fields   field. In the following operations, renamed the path parameter from   type   to   object : Get custom object definition Delete custom object definition Create custom object records Query custom object records Get custom object record Update custom object record Update individual fields in a custom object record Delete custom object record Update or delete custom object records as a batch Updated the limitations in the description of the “Update custom object definition” operation. In the "Query usage records" operation, removed  unitOfMeasure  from the description of the  filters  query parameter. In request body of the "Submit data query" operation, changed the enum value   JSONL   to   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!   2019-11-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 262, November 2019.   Workflows   - Added an operation called "Delete a workflow by ID". Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the "Create custom object definition" operation, updated the limitation of the Text field. In the 200 response body of the "Create custom object records" operation, updated the description of the   unprocessedRecords   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!   2019-11-06   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 261, November 2019.   Data Queries - In the request body of the “Submit data query” operation, added the useIndexJoin field. Orders - Made the following updates: In the request body of the "Create order" operation, changed the behaviors of the following fields for order actions that now support pending orders: subscriptions > orderActions > type subscriptions > orderActions > triggerDates subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate subscriptions > orderActions > addProduct > chargeOverrides > startDate > specificTriggerDate subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > specificTriggerDate In the response body of the "Get an order" and "Get order metrics for evergreen subscription" operations, changed the behaviors of the following fields for order actions that now support pending orders: order > subscriptions > orderActions > type order > subscriptions > orderActions > triggerDates order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate order > subscriptions > orderActions > addProduct > chargeOverrides > startDate > specificTriggerDate order > subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > specificTriggerDate In the response body of the following operations: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner changed the behaviors of the following fields for order actions that now support pending orders: orders > subscriptions > orderActions > type orders > subscriptions > orderActions > triggerDates orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate orders > subscriptions > orderActions > addProduct > chargeOverrides > startDate > specificTriggerDate orders > subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > specificTriggerDate Changed the behavior of the "Update order action trigger dates" operation. In the request body of following operations, changed the behaviors of the subscriptions > orderActions > termsAndConditions > lastTerm > startDate field by noting that you can now change the term start date of a renewed subscription through a T&Cs order action: Preview order Create order" In the following operations, removed the limitations on Orders for the Single Transaction Subscribe and Amend functionality: Preview subscription Create subscription Update subscription Renew subscription Cancel subscription Resume subscription Suspend subscription Create account CRUD: Update amendment CRUD: Delete Subscription CRUD: Update rate plan charge CRUD: Update Subscription CRUD: Delete Subscription In the following actions, removed the limitations on Orders for the Single Transaction Subscribe and Amend functionality: Subscribe Amend Create Query Update   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the response body of the "CRUD: Get invoice" operation, corrected the description of the following fields: IncludesOneTime IncludesRecurring IncludesUsage Moved the following operations to the Billing Documents section from the Accounts section. Generate billing documents by account Create job to hard delete billing document files Get job of hard deleting billing document files In the "Get billing documents" operation, updated the request sample. In the 200 response body of the “Get all custom object definitions” operation, made the following field updates: Changed id to Id Changed createdById to CreatedById Changed createdDate to CreatedDate Changed updatedById to UpdatedById Changed updatedDate to UpdatedDate Changed schema > properties > id to schema > properties > Id Changed schema > properties > createdById to schema > properties > CreatedById Changed schema > properties > createdDate to schema > properties > CreatedDate Changed schema > properties > updatedById to schema > properties > UpdatedById Changed schema > properties > updatedDate to schema > properties > UpdatedDate In the 200 response body of the “Create custom object definition” and “Get custom object definition” operations, made the following field updates: Changed id to Id Changed createdById to CreatedById Changed createdDate to CreatedDate Changed updatedById to UpdatedById Changed updatedDate to UpdatedDate Changed schema > properties > id to schema > properties > Id Changed schema > properties > createdById to schema > properties > CreatedById Changed schema > properties > createdDate to schema > properties > CreatedDate Changed schema > properties > updatedById to schema > properties > UpdatedById Changed schema > properties > updatedDate to schema > properties > UpdatedDate In the 200 response body of the “Create custom object records” and “Query custom object records” operations, made the following field updates: Changed records > id to records > Id Changed records > createdById to records > CreatedById Changed records > createdDate to records > CreatedDate Changed records > updatedById to records > UpdatedById Changed records > updatedDate to records > UpdatedDate In the 200 response body of the following operations Get custom object record Update custom object record Update individual fields in a custom object record made the following field updates: Changed id to Id Changed createdById to CreatedById Changed createdDate to CreatedDate Changed updatedById to UpdatedById Changed updatedDate to UpdatedDate In the response body of the following operations, changed the order (or orders ) > subscriptions > orderActions > termsAndConditions > lastTerm field to order (or orders ) > subscriptions > orderActions > termsAndConditions > initialTerm : Get an order 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" operation, updated the descriptions of the following fields to note that hyphens must not be used when you set the credit card number: newAccount > creditCard > cardNumber subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > creditCard > cardNumber In the source YAML file, duplicated the TriggerParams reference object as the following new reference objects: A reference object called PreviewOrderTriggerParams that is used in the request body of the “Preview order” operation. A reference object called CreateOrderTriggerParams that 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!   2019-11-01   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Removed the “Get all namespaces” and “Get namespace” operations from the Custom Object Definitions section. Renamed the “Get all custom object definitions in namespace” operation to “Get all custom object definitions”. Replaced the   {namespace}   path parameter with   default   in the endpoints of the following operations: Get all custom object definitions Create custom object definition Get custom object definition Delete custom object definition Create custom object records Query custom object records Get custom object record Update custom object record Update individual fields in a custom object record Delete custom object record Update or delete custom object records as a batch In the request body of the “Create custom object definition” operation, changed the following fields to required: properties   > property name *   >   type properties   > property name *  >   label In the 200 response body of the “Get all custom object definitions in default namespace” operation, made the following field updates: Changed  definitions   > property name *  >   relationships  to   definitions   > property name *  >   schema   >   relationships . Changed  definitions   > property name *  >   required   to  definitions   > property name *  >   schema   >   required . In the 200 response body of the " Create custom object" and "Get custom object definition"  operations, made the following field updates: Changed  relationships  to   schema   >   relationships . Changed   required  to   schema   >   required .  In the “Update custom object definition” operation, updated the limitations in the operation description. In the "Create custom object definition" operation, added the limitation for custom fields of Text type. In the request and 200 response body of the “Update custom object definition” operation, added the following missing fields: actions   >   label actions   >   field  >  definition  >  default actions   >   field  >  definition  >  description In the “Update or delete custom object records as a batch” operation, made the following updates: Changed the 200 response sample from a   delete   batch action response to an   update   batch action response. Updated the description of the   result   >   unprocessedIds   field in the response body.  Updated the description of the note in all the operations that are related to the Active Rating feature. ... 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!   2019-10-24   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 260, October 2019.   Payment Methods   - In the request body of the "Cancel authorization" operation, made the following updates: Added the optional   paymentGatewayId   field. Updated the   accountId   and   accountNumber   fields from required to optional, and clarified that they are not required if Ingenico ePayments gateway is used. Workflows   - Added the following operation: Get a workflow by ID   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Get product catalog” operation, added the   page   query parameter. In the “Get product rate plans” operation, added the   page   query parameter. In the “Usage (with Active Rating)” section, clarified that if a 500 or 502 error occurs when you call any of the Usage (with Active Rating) operations, the first troubleshooting step is to retry the call. In the description of the “Create usage records” operation, clarified that the account to create usage records for must have a corresponding usage-based rate plan charge. In the description of the "Run a workflow" operation, added that input parameters can be included in the request body and provided a link to a Knowledge Center article that explains how to define input parameters for a workflow. In the description of the "Scrub payment method" operation, clarified that a payment method must be scrubbed before anonymizing its associated account and contact. ... 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!   2019-10-16   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 259, October 2019. Subscriptions   - Added the following fields to the request body of the "Create subscription" operation: gatewayId paymentMethodId Workflows   - Added the following operations: Run a workflow Import a workflow Export a workflow Get tasks Get a task by ID Update tasks in 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!   2019-10-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 258, October 2019.   Custom Object Definitions -  Added a resource called "Custom Object Definitions", with the following operations : Get all namespaces Get namespace Get all custom object definitions in namespace Create custom object definition Get custom object definition Delete custom object definition Update custom object definition Custom Object Records -  Added a resource called "Custom Object Records", with the following operations : Create custom object records Query custom object records Get custom object record Update custom object record Update individual fields in a custom object record Delete custom object record Update or delete custom object records as a batch Settings -  Added a resource called "Settings", with the following operations : List all settings Submit multiple settings requests as a batch Data Queries -  In the request body of the "Submit data query" operation, changed the  JSON  value of the  outputFormat  field to  JSONL .    Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the "Preview order" operation, added descriptions for the subscriptions > orderActions > updateProduct > chargeUpdates field. In the request body of the "Amend" action, updated the description of the requests > Amendments > Type field. In the request body of the "Subscribe" action, updated the description of the subscribes > Account > DefaultPaymentMethodId field. In the "Create order" operation, added the missing query parameter returnIds and the following missing response fields: orderId accountId subscriptionIds subscriptions > subscriptionId invoiceIds creditMemoIds paymentId In the following operations, corrected the data type to  number  for all fields that previously had the  string <decimal>  data type. Preview subscription Create subscription Get subscriptions by account Update subscription Get subscriptions by key Get subscriptions by key and version Renew subscription Cancel subscription Resume subscription Suspend subscription In the "Create revenue schedule on subscription charge" operation, updated the description to clarify that a maximum of 3,000 revenue schedules can be created for one subscription charge. In the "Get custom foreign currency exchange rates" operation, updated the request sample and the response sample. In the description of the "Generate an OAuth token" operation, added more details about the rate limit of the operation. In the Introduction section, added links to Zuora Collect API Reference and RevPro API Reference. Added a section called Usage (With Active Rating), containing the following operations. Previously, these operations were documented on a separate page. Create usage records Update usage record Get usage record Delete usage record Query usage records Query usage records in stream Import usage file Get usage imports Get details of usage import Get status of usage import Download usage import file Download usage import failure file Download usage file template Get rating results by account Get rating results by subscription Get rating results by charge Get rated usage by account Get rated usage by subscription Get rated usage by charge Get Usage custom field definition Set schema of Usage custom field definition Delete schema of Usage custom field definition ... 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!   2019-09-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 257, September 2019.   Credit Memos - Made the following updates: In the request body of the "Create credit memo from charge" operation: Changed the behavior of the charges > chargeId field. The availability of this field now depends on the zuora-version request header. Added the produceRatePlanChargeId nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later. Changed the behavior of the charges > comment field. The availability of this field now depends on the zuora-version request header. Added the description nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later. In the response body of the "Get credit memo items" operation: Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header. Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later. In the response body of the "Get credit memo item" operation: Changed the behavior of the comment field. The availability of this field now depends on the zuora-version request header. Added the description field. This field is only available if you set the zuora-version request header to 257.0 or later. Debit Memos - Made the following updates: In the request body of the "Create debit memo from charge" operation: Changed the behavior of the charges > chargeId field. The availability of this field now depends on the zuora-version request header. Added the produceRatePlanChargeId nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later. Changed the behavior of the charges > comment field. The availability of this field now depends on the zuora-version request header. Added the description nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later. In the response body of the "Get debit memo items" operation: Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header. Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later. In the response body of the "Get debit memo item" operation: Changed the behavior of the comment field. The availability of this field now depends on the zuora-version request header. Added the description field. This field is only available if you set the zuora-version request header to 257.0 or later. Invoices - Made the following updates: In the request body of the "Create credit memo from invoice" operation: Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header. Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later. In the request body of the "Create debit memo from invoice" operation: Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header. Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Moved the “Get the revenue automation start date” operation from the "Settings" section to the “Revenue rules” section. Removed the deprecated "Get billing information 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!   2019-09-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 256, September 2019.   Data Queries  - In the request body of the "Submit data query" operation, made the following updates: Added TSV and DSV to the enum values of the outputFormat field. Added the columnSeparator field. Use this field to pass in your custom delimiter when you set the outputFormat field to DSV .   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the 200 response body of the "Submit data query" operation, added descriptions for the enum values of the data > queryStatus field. Added the missing "CRUD: Update rate plan charge" operation. In the "CRUD: Update invoice" operation, corrected the request example. ... 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!   2019-08-28   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 255, August 2019. Credit Memos - Made the following updates: In the response body of the following operations, added the taxStatus and taxMessage fields: Create credit memo from charge Get credit memo Update credit memo Apply credit memo Unapply credit memo Cancel credit memo Post credit memo Unpost credit memo In the response body of the "Get credit memos" operation, added the following fields to the creditmemos field: taxStatus taxMessage Debit Memos - Made the following updates: In the request body of the "Create debit memo from charge" operation: Added the accountNumber field. Changed the behavior of accountId field. This field is now conditionally required. You must specify accountNumber , accountId , or both in the request body. In the response body of the following operations, added the taxStatus and taxMessage fields: Create debit memo from charge Get debit memo Update debit memo Cancel debit memo Post debit memo Unpost debit memo In the response body of the "Get debit memos" operation, added the following fields to the debitmemos field: taxStatus taxMessage Invoices - In the response body of the following operations, added the taxStatus and taxMessage fields: Create credit memo from invoice Create debit memo from invoice   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference. In the request body of the following operations, added the missing ProductRatePlanChargeTierData field and its nested fields: CRUD: Create product rate plan charge CRUD: Update product rate plan charge In the request sample of the following operations, removed the ProductRatePlanChargeTierData > ProductRatePlanChargeTier > Active field: CRUD: Create product rate plan charge CRUD: Update product rate plan charge Added the missing “CRUD: Update ProductRatePlanChargeTier” operation. In the “Get credit card payment methods for account” operation, updated the description to clarify that the response does not include effective details for ACH payment methods if this operation is used to get ACH payment methods. ... 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!   2019-08-15   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Amend" action, added the following missing fields to the requests > Amendments field in the request body: ResumeDate SuspendDate ... 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!   2019-08-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 253, July 2019.   Workflows - Added a new resource called “Workflows”, with   the “Get workflows” operation for retrieving workflows on a tenant . Filters can be used to retrieve specific workflows. If no filters are specified, all workflows will be returned.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added more information about the REST endpoint base UL of the US Production Copy Environment . In the "Create payment method" operation, corrected the names of the following fields: bankAccountName bankAccountNumber bankAccountType bankName Previously, they were incorrectly documented as: achBankAccountName achBankAccountNumber achBankAccountType achBankName ... 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!   2019-08-01   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the missing Zuora-Entity-Ids request header in the following operations: Get revenue recognition rule by product rate plan charge Create revenue schedule for credit memo item (manual distribution) Get revenue schedule by credit memo item ID Create revenue schedule for credit memo item (distribute by date range) Create revenue schedule for debit memo item (manual distribution) Get revenue schedule by debit memo item ID Create revenue schedule for debit memo item (distribute by date range) Get all revenue schedules of product charge by charge ID and billing account ID In the request body of the “Create stored credential profile” operation, added the missing networkTransactionId field. In the request body of the "CRUD: Update account" operation, corrected the descriptions of the following fields: Currency Status In the response body of the "CRUD: Get account" operation, corrected the descriptions of the Status field. In the request body of the "CRUD: Create account" operation, corrected the descriptions of the Status field. In the Zuora Object Model section, added more information about the differnces between the BillingRun object and BillRun object. In the response body of the "CRUD: Get payment method" operation, updated the description of the Active and PaymentMethodStatus fields to distinguish them. In the request body of the "CRUD: Update payment method" operation, updated the description of the PaymentMethodStatus field for better clarity. ... 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!   2019-07-26   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Release 252, July 2019.   Credit Memos - Changed the behavior of the "Apply credit memo" operation. You can now use this operation to perform the following operations: Apply negative credit memo items to negative invoice items or debit memo items. Apply negative credit memo items to the taxation items of negative invoice items or debit memo items. Apply the taxation items of negative credit memo items to negative invoice items or debit memo items. Apply the taxation items of negative credit memo items to those of negative invoice items or debit memo items. Debit Memos - Changed the behavior of the "Create debit memo from charge" operation. You can now use this operation to create negative debit memo items from negative product rate plan charges. Invoices - Changed the behavior of the "Create debit memo from invoice" operation. You can now use this operation to create negative debit memo items from negative invoice items.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Create payment method" operation, made the following updates: Added the following missing fields to the request body: bankABACode achBankAccountName achBankAccountNumber achBankAccountType achBankName addressLine1 addressLine2 phone city country state zipCode Clarified that these fields are applicable to ACH payment methods. In the "Get revenue schedule by invoice item adjustment" operation, corrected the description of the invoice-item-adj-key path parameter. In the code sample of the request body for the following operations: Create revenue schedule for credit memo item (distribute by date range) Create revenue schedule for debit memo item (distribute by date range) Made the following updates: Removed the redundant top-level application/json field. Corrected the eventType and eventTypeSystemId field to avoid confusion. In the request body of the following operations, corrected the data type of the billingCycleDay field to string : Create payment run Update payment run In the response body of the "Get payment run" operation, corrected the data type of the billingCycleDay field to string . ... 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!   2019-07-21   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Release 251, July 2019.   Contacts - Changed the behavior of the “Scrub contact” operation. The value of the country field becomes null instead of 0 after scrubbing as of this release.   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 usage", made the following updates: Added the following missing fields: ChargeNumber Description SubscriptionNumber Removed the unsupported Rbestatus field. In the response body of the "CRUD: Create usage", added the following missing fields: Description SubscriptionNumber ... 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!   2019-07-11   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 250, July 2019.   Invoices - In the request body of the "CRUD: Update invoice" operation, changed the behavior of the RegenerateInvoicePDF field by adding a limit that you can use this field to regenerate PDF files for the same invoice for at most 100 times.   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 invoice" operation, added the missing RegenerateInvoicePDF field. In the description of the "Create authorization" operation, made the following updates: Clarified the subsequent operations as part of the Delayed Capture feature. Added a known limitation of the Delayed Capture feature. In the description of the "CRUD: Create payment" operation, clarified that this operation cannot work if the Invoice Settlement feature is enabled. In the request body of the "CRUD: Create payment method" operation, removed the MitProfileAgreedOn field. The details of this field are moved to the PaymentMethod article in Zuora's Knowledge Center. In the request body of the "Amend" action, updated the description of the requests > Amendments > ServiceActivationDate field to add more information about how to use this field. In the request body of the "CRUD: Update amendment" operation, updated the description of the ServiceActivationDate field to add more information about how to use this field. In the response body of the "CRUD: Get amendment" operation, updated the description of the ServiceActivationDate field to add more information about how to use this field. Corrected the endpoints of the following asynchronous Orders operations: Preview order asynchronously Create order asynchronously Get job status and response ... 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!   2019-07-04   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" operation, added the following missing nested fields to the metrics fields: totalDebitMemoBalance unappliedPaymentAmount unappliedCreditMemoAmount In the 200 response body of the "CRUD: Get payment" operation, added the missing Processing enum value to the Status field. In the request body of the "CRUD: Create payment method" operation, made the following updates: Added the missing BankTransferAccountName , BankTransferAccountNumber , and BankTransferAccountNumberMask fields. Added the missing SEPA enum value for the BankTransferType field. In the response body of the "CRUD: Get payment method" operation, made the following updates: Added the missing BankTransferAccountNumber field. Added the missing SEPA enum value for the BankTransferType field. In the request body of the "Amend" action, updated the description of the requests > Amendments > CustomerAcceptanceDate field to add more information about how to use this field. In the request body of the "CRUD: Update amendment" operation, updated the description of the CustomerAcceptanceDate field to add more information about how to use this field. In the response body of the "CRUD: Get amendment" operation, updated the description of the CustomerAcceptanceDate field to add more information about how to use this 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!   2019-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 “Create a notification definition” operation, added an example of how to get the communication profile Id to the description of the communicationProfileId field. In the request body of the following operations, updated the description of the subscriptions > orderActions > updateProduct > specificUpdateDate field to add more information about how to use this field: Create order Preview order In the response body of the following operations, updated the description of the order ( orders ) > subscriptions > orderActions > updateProduct > specificUpdateDate field to add more information about how to use this field: Get an order Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Get order metrics for evergreen subscription In the description of the "Create authorization" and "Cancel authorization" operations, added the missing "Chase Paymentech Orbital" and "Ingenico ePayments" to the payment gateways that support both operations. ... 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!   2019-06-20   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Release 249, June 2019.   Payment Methods - Added the cardSecurityCode field in the request body of the “Create stored credential profile” 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 “Subscribe” action, added the description for the subscribes > PreviewOptions > EnablePreviewMode field as a workaround to avoid potential charges for payment method validation in subscription and amendment previews. In the descriptions of the "Create order" and "Preview order" operations, added notes to inform customers about the limits on Orders. In the Authorization header parameter of the following operations, added the description that the OAuth token must be regenerated after the Notification and the Configurable Event features are enabled in your Zuora tenant: 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 In the eventCategory query parameter of the following operations, added the description that two formats are supported: Get callout notification histories Get email notification histories In the response body of the "Get account" operation, added the missing sequenceSetId nested field to the basicInfo field. Corrected the endpoint URL of the "Upload file for invoice" operation to /v1/invoices/{invoice-id}/files . Corrected the endpoint URL of the "Upload file for credit memo" operation to /v1/creditmemos/{creditMemoId}/files . Corrected the endpoint URL of the "Upload file for debit memo" operation to /v1/debitmemos/{debitMemoId}/files . In the following operations, changed the path parameter name from invoice-id to invoiceId . Get invoice files Get invoice items In the “Get taxation items of invoice item” operation, changed the following path parameter names: Changed invoice-id to invoiceId Changed item-id to itemId In the response body of the "Get product catalog" operation, corrected the URL example in the description of the products > productRatePlans field. In the response body of the "Get product" operation, corrected the URL example in the description of the productRatePlans 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!   2019-06-12   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 method" operation, updated the note of the AccountId field to say that, if a payment method is already associated with a customer account, you cannot update the payment method to associate it with another account ID. In the request body of the "Create credit card payment method" operation, corrected the cardHolderInfo > cardHolderName field from optional to required. In the introduction of the "Create payment method" operation, updated the description for the credit card method to emphasize that the cardHolderInfo > cardHolderName field in the request body is required for this type of payment method. In the descriptions of the following actions, added the limitations of supported object types: Create Update In the “Write off invoice” operation, simplified the request example. In the response body of the “CRUD: Get rate plan charge” operation, corrected ServiceActivationDate to ServiceActivation in the description of the TriggerEvent field. ... View more

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!   2019-05-27   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Release 247, May 2019.   Contacts - Changed the behavior of the “CRUD: Update contact” operation. You can now edit contacts for canceled accounts.   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 product catalog” operation, noted the array size limit to the description of the products > productRatePlans field. In the response body of the “Get product” operation, noted the array size limit to the description of the productRatePlans field. In the “Upload file for credit memo” operation, changed the path parameter name from id to creditMemoId . In the “Upload file for debit memo” operation, changed the path parameter name from id to debitMemoId . In the “Upload file for invoice” operation, changed the path parameter name from id to invoiceId . In the response body of the Update action, corrected the type of the fieldsToNull nested field from string to array . In the source YAML file, renamed the CreatePMPayPalEC&PayPalNativeEC reference object to CreatePMPayPalECPayPalNativeEC . ... View more

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!   2019-05-20   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 246, May 2019.   Contacts   - Added a new operation called “Scrub contact”. Credit Memos   - Added a new operation called “Upload file for credit memo”. Debit Memos   - Added a new operation called “Upload file for debit memo”. Invoices   - Made the following updates: Added a new operation called “Upload file for invoice”. In the response body of the “Get invoice items” operation, added the availableToCreditAmount nested field to the invoiceItems field and invoiceItems >   taxationItems   >   data   field. In the response body of the “Get taxation items of invoice item” operation, added the   availableToCreditAmount  nested  field to the   data   field. Accounts   - Changed the behavior of the “Generate billing documents by account” operation. You can now generate billing documents for all subscriptions except for cancelled and suspended subscriptions. Previously, you could only generate billing documents for active subscriptions. Payment Methods   - Made the following updates: Removed the   networkTransactionId   field from the response body of the “Get stored credential profiles” operation. Added the   mitProfileAgreedOn   field to the request body of the following operations: Create payment method Create credit card payment method Added the   agreedOn   field to the request body of the “Create Stored Credential Profile” operation. Added the   MitProfileAgreedOn   field to the request body of the “CRUD: Create payment method” operation. Payment Gateway Reconciliation   - Added the Payment Gateway Reconciliation section that includes the following operations: Settle Payment Reject Payment Reverse Payment   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the descriptions of the following operations, noted that these API operations are now in Limited Availability: Get billing information for order Request breakdown of invoice items by order Get breakdown of invoice by order Request breakdown of credit memo items by order Get breakdown of credit memo by order In the response body of the “CRUD: Get usage” operation, corrected the description of the   CreatedDate   field. Renamed the Link Queries section to Data Queries. Also renamed the operations in this section: Renamed “Submit Link query” to “Submit data query”. Renamed “Get Link query jobs” to “Get data query jobs”. Renamed “Get Link query job” to “Get data query job”. Renamed “Cancel Link query job” to “Cancel data query job”. In the source YAML file, renamed the following reference objects: Renamed   SubmitLinkQueryRequest   to   SubmitDataQueryRequest . Renamed   SubmitLinkQueryResponse   to   SubmitDataQueryResponse . Renamed   GetLinkQueryJobsResponse   to   GetDataQueryJobsResponse Renamed   GetLinkQueryJobResponse   to   GetDataQueryJobResponse . Renamed   DeleteLinkQueryJobResponse   to   DeleteDataQueryJobResponse . Renamed   LinkQueryJobCommon   to   DataQueryJobCommon . Renamed   LinkQueryJob   to   DataQueryJob . Renamed   LinkQueryJobCancelled   to   DataQueryJobCancelled . Renamed   LinkQueryErrorResponse   to   DataQueryErrorResponse . Added the   X-Zuora-WSDL-Version   request header to the following actions: Amend Create Delete Execute Generate Query QueryMore Subscribe Update ... View more