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

2020-08-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 284, August 2020.   Rate Plan Charges   - In  the "CRUD: Update rate plan charge" operation, enhanced the  TriggerEvent  request field to support directly updating the trigger condition of a rate plan charge for Order customers. If you are Zuora's Subscribe and Amend customers, you already have the access to this feature. Subscriptions   - Made the following updates: In the response body of each of the following operations, added the   subscriptionEndDate   field. Get subscriptions by key Get subscriptions by key and version In the response body of the "Get subscriptions by account" operation, added the   subscriptions   >   subscriptionEndDate   field.   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, added the missing   DirectEntryAU   enum value to the   BankTransferType   field. In the request body of the "Subscribe" action, added the missing   NativeExpressCheckout   enum value  to the  subscribes  >  PaymentMethod  >  PaypalType  field . ... View more

2020-08-13   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 283, August 2020.   Credit Memos   - Made the following updates: In the request body of the "Update credit memo" operation, added support for custom fields to the   items   >   taxItems   field. In the response body of the "Get credit memo items" operation, added support for custom fields to the the following fields: items   >   creditTaxItems items   >   taxationItems   >   data In the response body of the "Get credit memo item" operation, added support for custom fields to the following fields: creditTaxItems taxationItems   >   data In the response body of the "Get taxation items of credit memo item" operation, added support for custom fields to the   data   field. You can now update and retrieve the custom fields of the Credit Taxation Item object for all credit memos regardless of their status. Debit Memos   - Made the following updates: In the request body of the "Update debit memo" operation, added support for custom fields to the   items   >   taxItems   field. In the response body of the "Get debit memo items" operation, added support for custom fields to the following fields: items   >   taxItems items   >   taxationItems   >   data In the response body of the "Get debit memo item" operation, added support for custom fields to the following fields: taxItems taxationItems   >   data In the response body of the "Get taxation items of debit memo item" operation, added support for custom fields to the   data   field. You can now update and retrieve the custom fields of the Debit Taxation Item object for all debit memos regardless of their status. Orders   - Updated the API limitation for the following API operations: Create order Preview order Create order asynchronously Preview order asynchronously   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 description of the   basicInfo   >   defaultPaymentMethod   >   id   field. In the request body of the "Create account" operation, corrected the description of the   hpmCreditCardPaymentMethodId   field. In the request body of each of the "Create order" and "Create order asynchronously" operations, updated the description of the following fields for consistency: newAccount   >   hpmCreditCardPaymentMethodId subscriptions   >   orderActions   >   createSubscription   > newSubscriptionOwnerAccount   >   hpmCreditCardPaymentMethodId In the request body of each of the following operations, updated the description of the   subscriptions   >   orderActions   >   createSubscription   > newSubscriptionOwnerAccount   >   hpmCreditCardPaymentMethodId   field for consistency: Preview order Preview order asynchronously In the request body of each of the following operations, removed the incorrect description of the default value for the   initialTerm   field. Preview subscription Create subscription In the request body of the "Put subscription" operation, removed the incorrect description of the default value for the   currentTerm   field. In the request body of the "CRUD: Update Subscription" operation, removed the incorrect description of the default value for the   InitialTerm   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-08-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 282, August 2020.   Payment Methods   - Added the   gatewayOptions   field to the request body of each of the following operations: Create credit card payment method Update credit card payment method Actions   - Made the following updates: In the request body of the "Amend" action, updated the character limit of the   request   >   AmendOptions >   ExternalPaymentOptions   >   ReferenceId   field from 60 to 100. In the request body of the "Subscribe" action, updated the character limit of the   subscribes   >   SubscribeOptions >   ExternalPaymentOptions   >   ReferenceId   field from 60 to 100. Payment Gateway Reconciliation   - In the request body of each of the "Reject payment" and "Reverse payment" operations, updated the character limit of the following fields from 60 to 100: referenceId secondReferenceId Payments   - Made the following updates: In the request body of each of the following operations, updated the character limit of the   referenceId   field from 60 to 100: Create payment Update Payment In the request body of each of the following operations, updated the character limit of the   ReferenceId   field from 60 to 100: CRUD: Create payment CRUD: Update payment In the request body of the "Refund payment" operation, updated the character limit of the following fields from 60 to 100: referenceId secondRefundReferenceId Refunds   - In the request body of the "Update refund" operation, updated the character limit of the   referenceId   field from 60 to 100. Credit Memos   - In the request body of the "Refund credit memo" operation, updated the character limit of the following fields from 60 to 100: referenceId secondRefundReferenceId Revenue Schedules   - In the request body of each of the following operations, updated the character limit of the   referenceId   field from 60 to 100: Update revenue schedule basic information Create revenue schedule on subscription charge Credit Balance Adjustments   - In the request body of the "CRUD: Create CreditBalanceAdjustment" operation, updated the character limit of the   ReferenceId   field from 60 to 100. Invoice Adjustments   - In the request body of the "CRUD: Create InvoiceAdjustment" operation, updated the character limit of the   ReferenceId   field from 60 to 100. Taxation Items   - Made the following updates: Changed the behavior of the "Update taxation item" operation. You can now update the custom fields of the Taxation Item object for all invoices, credit memos, and debit memos regardless of their status. Previously, you could only update the custom fields of the Taxation Item object for invoices, credit memos, and debit memos in Draft status. Changed the behavior of the "CRUD: Update TaxationItem" operation. You can now update the custom fields of the Taxation Item object for all invoices regardless of their status. Previously, you could only update the custom fields of the Taxation Item object for invoices in Draft status.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the “Perform mass action” operation, added a reference link to the   Mass Payment Upload   article. In the "Query custom object records" operation, added a note to the description of the   q   query parameter. In the description of the "Create an event trigger" operation, made the following updates: Restructured the description. Added the list of tenant level base objects. Noted the availabilities of tenant level event triggers and system notifications. ... 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-07-31   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the reference link to the newly published   API Guides,   which cover common REST API use cases. Updated the description of the “Data Queries” section. ... 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-07-24   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Removed the mistakenly documented "CRUD: Delete payment method snapshot" operation. Added the 403 response schema and sample to the "Get data query job" operation. Added the access control explanations to the descriptions of the following operations: Get data query jobs Get data query job Updated the description in the "Error Handling" section. ... 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-07-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 281, July 2020.   Orders   - Made the following updates: Added the   returnId   query parameter to the "Create order asynchronously" operation. In the response body of the "Get job status and response" operation, added the following nested fields to the   result   field: accountId creditMemoIds invoiceId orderId paymentId subscriptionIds Invoices   - Changed the behavior of the “Write off invoice” operation. If you set the   Create credit memos mirroring invoice items   billing rule to   Yes, you can now write off an invoice even if all its items have zero balance. Doc Updates This section lists the documentation updates that were made in this version of the API Reference. In the request body of the "Create payment method" operation, added the missing   accountHolderInfo   field and its nested fields. In the request body of the "Create account" operation, added the missing   accountHolderInfo   nested field to the   paymentMethod   field. In the request body of the following operations, added the missing   accountHolderInfo   nested field to the   newAccount   >   paymentMethod   field: Create order Create order asynchronously In the request body of the following operations, added the missing   accountHolderInfo   nested field to the   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   paymentMethod   field: Preview order Preview order asynchronously Corrected the examples in the description of each of the following operations: Get credit memos Get debit memos ... 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-07-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 280, July 2020.   Product Rate Plans - In the response body of the “Get product rate plans” operation, made the following updates: Added the following values to the productRatePlans > productRatePlanCharges > model field: MultiAttributePricing PreratedPerUnit PreratedPricing HighWatermarkVolumePricing HighWatermarkTieredPricing Changed the behavior of the productRatePlans > productRatePlanCharges > pricingSummary field. Subscriptions - Made the following updates In the request body of the following operations, added the chargeModelConfiguration nested field to the subscribeToRatePlans > chargeOverrides field: Preview subscription Create subscription In the request body of the "Update subscription" operations, added the chargeModelConfiguration  nested  field to the following fields: add > chargeOverrides update > chargeUpdateDetails In response body of the "Get subscriptions by account" operation, added the chargeModelConfiguration nested field to the subscriptions > ratePlans > ratePlanCharges field. In response body of the following operations, added the chargeModelConfiguration  nested  field to the ratePlans > ratePlanCharges field: 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, added the chargeModelData field and its nested fields to the following fields: subscriptions > orderActions > addProduct > chargeOverrides > pricing subscriptions > orderActions > updateProduct > chargeUpdates > pricing subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing In the the response body of the following operations, added the chargeModelData field and its nested fields to the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > field: Get an order Get order metrics for evergreen subscription In the response body of the following operations, added the chargeModelData field and its nested fields to the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing 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 following operations, changed the behavior of the subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > triggerEvent field: Create order Create order asynchronously Currently, if the triggerEvent field is not specified, the value of this field will be defaulted to the trigger event value in the product catalog. Previously, if this field was not specified, the value of the field would be defaulted to the trigger event value in the base subscription on which the order was created. This behavior change was introduced in Zuora Billing Release 279. Added the rejectUnknownFields query parameter to the following operations: All Actions All CRUD operations that use the POST method All CRUD operations that use the PUT method Accounts - In the request body of the "CRUD: Update account" operation, changed the behavior of the AccountNumber field. See the description of the AccountNumber field to find out details about the latest behavior.   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, corrected the description of the mitProfileAgreedOn field: Create payment method Create credit card payment method Create account Create order Create order asynchronously Preview order Preview order asynchronously In the request body of the following operations, corrected the description of the items > skuName field: Create credit memo from invoice Create debit memo from invoice Write off invoice ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-06-28   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In  the request body of the "Update taxation item" operation, updated the following fields from required to optional: jurisdiction name taxAmount taxRate taxRateType . ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-06-24   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the "Write off invoice" operation, clarified the restrictions on invoice write-off. ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-06-12   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   I n the request body of the “Update or delete custom object records as a batch” operation, added the missing   type   property for the   action   >   ids   field. In the request sample of the "Create custom object definition" operation, added the   filterable   field with its value. In the response sample of the "Get all custom object definitions" operation, added the   definitions   >   person   >   schema   >   filterable   field with its value. In the response sample of the following operations, added the   schema   >   filterable   field with its value: Create custom object definition Get custom object definition In the request body of the "Subscribe" action, added the missing description for the   subscribes   >   SubscribeOptions   >   SubscribeInvoiceProcessingOptions   >   InvoiceProcessingScope   field. ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-06-04   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the “Submit data query” operation, updated the description of the enum value  JSON  for the  outputFormat  field . ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-05-29   Recent Error Code Updates   This section summarizes the error category code updates that have been made since May.   The following changes are available since Zuora Billing Release 275:   Deprecated the   00   error category code because it was not informative to API users. The previous   00   error category code was reclassified into other error category codes based on the actual error type. Redefined the   99  error category code as the integration error. Previously, it was defined as the extension error.   The following changes are available since Zuora Billing Release 276:   Added the   45   error category code. Migrated some errors of the   60   error category to other error categories based on the specific error type.   Previously, we did not fully document the changes made to the error codes that are returned within the response. Going forward, we will include the error code changes in the API Changelog to improve our API documentation. For more information about Billing error codes, see   Error Handling.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the error handling information to the descriptions of the "Custom Object Definitions" and "Custom Object Records" sections. Added the error code information to the description of the   details   >   code   field in the 400 and 500 response schema of the following operations: Create custom object records Update or delete custom object records as a batch ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-05-21   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Billing Release 277, May 2020.   Custom Object Records   - Updated the response schemas and samples for each of the following operations: Create custom object records Update or delete custom object records as a batch   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Removed the Eearly Adopter disclaimer from all the operations of "Custom Object Definitions" and "Custom Object Records". In the request body of the "CRUD: Create product" and "CRUD: Update product" operations, removed the character limit information from the description of each of the following fields: EffectiveEndDate EffectiveStartDate In the response body of the "CRUD: Get product" operation, removed the character limit information from the description of each of the following fields: EffectiveEndDate EffectiveStartDate UpdatedDate ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-05-14   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Billing Release 276, May 2020.   Error Category   - In the error category table, added   45   as a new error category code for the Billing REST API.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the following headers for all operations that did not have these headers: Zuora-Track-Id   header in the request Zuora-Track-Id   header in each response Zuora-Request-Id   header in each response Added the following missing operations: CRUD: Create Feature CRUD: Update Feature In the request body of the following operations, added the missing   ActiveCurrencies   field: CRUD: Create product rate plan CRUD: Update product rate plan In the response body of the "CRUD: Get product rate plan" operation, added the missing   ActiveCurrencies   field. Removed the note about how to access the Suspend and Resume feature from the following operations: Suspend subscription Resume subscription CRUD: Get amendment CRUD: Update amendment Amend Create order Create order asynchronously Preview order Preview order asynchronously Get an order Get order metrics for evergreen subscription Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-05-07   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Billing Release 275, May 2020.   Orders   - In the request body of the "Creat order" operation, changed the behavior of the   subscriptions   >   orderActions   >   updateProduct   >   chargeUpdates   >   effectiveDate   >   specificTriggerDate   field. This behavior change is available only when the Pending order feature is not enabled. See the description of the   specificTriggerDate   field to find out details about the latest behavior. Credit Memos   - In the request body of the "Refund credit memo" operation, added the   gatewayOptions   field. Payments   - In the request body of the "Refund payment" operation, added the   gatewayOptions   field. Invoices   - Changed the behavior of the following operations. You can only write off or reverse an invoice if it contains at most 750 items. Reverse invoice Write off invoice   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the   Error Handling   section to document general information about handling error codes returned by Zuora Billing REST API with an endpoint starting with   /v1   ( except  Actions  and  CRUD operations). Added a limitation to the description of the “Create an event trigger” operation. In the source YAML file, duplicated the   CreateOrderTriggerParams   reference object as a new reference object called   CreateOrderUpdateProductTriggerParams , which is used in the request body of the “Create order” operation. ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-04-30   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the "CRUD: Update payment" operation, removed the unsupported   Comment   field. In the request body of the "Create account" operation, made the following updates: Updated the   creditCard   field description to clarify that this field has been deprecated, and is currently available only for backward compatibility. In the   paymentMethod   field, made the following updates: Added the following missing supported payment method types to the   type   nested field: PayPalEC PayPalNativeEC PayPalAdaptive SEPA Betalingsservice Autogiro Bacs Added the following missing nested fields: BAID checkDuplicated preapprovalKey mitProfileAction mitProfileType mitProfileAgreedOn mitConsentAgreementSrc mitConsentAgreementRef mitNetworkTransactionId IBAN businessIdentificationCode accountNumber identityNumber bankCode branchCode makeDefault authGateway accountKey Made the following updates for the General Available release of the Suspend and Resume feature: Updated the description for each of the following operations: Suspend subscription Resume subscription In the response body of the "CRUD: Get amendment" operation, updated the description of the   Type   field. In the request body of the "CRUD: Update amendment" operation, updated the description of the   Type   field. In the request body of the "Amend" action, updated the description for each of the following fields: requests   >   Amendments   >   SuspendDate requests   >   Amendments   >   ResumeDate requests   >   Amendments   >   Type In the request body of each of the following operations: Create order Create order asynchronously Preview order Preview order asynchronously Updated the description for each of the following fields: subscriptions   >   orderActions   >   suspend subscriptions   >   orderActions   >   resume In the response body of each of the following operations: Get an order Get order metrics for evergreen subscription Updated the description for each of the following fields: order   >   subscriptions   >   orderActions   >   suspend order   >   subscriptions   >   orderActions   >   resume In the response body of each of the following operations: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Updated the description for each of the following fields: orders   >   subscriptions   >   orderActions   >   suspend orders   >   subscriptions   >   orderActions   >   resume In the request body of each of the following operations: Create order Create order asynchronously Corrected the description for each of the following fields: newAccount   >   taxInfo   >   exemptStatus newAccount   >   taxInfo   >   exemptCertificateId newAccount   >   taxInfo   >   exemptCertificateType newAccount   >   taxInfo   >   exemptEffectiveDate newAccount   >   taxInfo   >   exemptExpirationDate newAccount   >   taxInfo   >   exemptDescription subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the request body of each of the following operations: Preview order Preview order asynchronously Corrected the description for each of the following fields: previewAccountInfo   >   taxInfo   >   exemptStatus previewAccountInfo   >   taxInfo   >   exemptCertificateId previewAccountInfo   >   taxInfo   >   exemptCertificateType previewAccountInfo   >   taxInfo   >   exemptEffectiveDate previewAccountInfo   >   taxInfo   >   exemptExpirationDate previewAccountInfo   >   taxInfo   >   exemptDescription subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the response body of each of the following operations: Get an order Get order metrics for evergreen subscription Corrected the description for each of the following fields: order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate order   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the response body of each of the following operations: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Corrected the description for each of the following fields: orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptStatus orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateId orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptCertificateType orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptEffectiveDate orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptExpirationDate orders   >   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   taxInfo   >   exemptDescription In the descritpion of the "Create order" operation, updated the note about the operation rollback. ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-04-23   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request and response samples of the “Create a notification definition” operation, replaced   "AccountNumber": "<Account.Number>"   with   "AccountNumber": "<Account.AccountNumber>" Added limitations to the description of the “Create an event trigger” operation. In the request body of the "Create payment method" operation, removed the   enum   property from the   type   field and updated the field description. In the "RevPro Integration" section, made the following updates: Renamed this section as "Zuora Revenue Integration". Updated the description of this section. Renamed the "Update an accounting code" operation to "Update Zuora Revenue accounting code" to be more accurate. Updated the description of the "Update Zuora Revenue accounting code" operation. ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!   2020-04-17   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Billing Release 274, April 2020.   Data Queries - In the response body of each of the following operations, added the createdBy nested field to the data field: Submit data query Get data query jobs Get data query job Cancel data query job   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the "Settings" section, removed all the "In Development" notes. ... View more

This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!     2020-04-02   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the following operations, noted that it is best practice to set the  zuora-version  parameter to  211.0  or later if you have Invoice Settlement enabled; otherwise, an error occurs. Create subscription Update subscription Renew subscription Cancel subscription Resume subscription Suspend subscription ... View more