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

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-08   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Added the following operations: CRUD: Create CreditBalanceAdjustment CRUD: Update CreditBalanceAdjustment In the 200 respsonse body of the following operations, added the processId and reasons fields: Update account Activate accounting code Deactivate accounting code Delete accounting code Update an accounting code Close accounting period Set accounting period to pending close Update accounting period Delete accounting period Re-open accounting period Run trial balance Edit attachments Delete attachments Email billing documents generated from bill run Multi-entity: Share a product with an Entity Establish connection to Zuora REST API service Delete credit memo Email credit memo Get breakdown of credit memo by order Request breakdown of credit memo items by order Update debit memos Delete debit memo Email debit memo Delete document properties Update invoices Email invoice Delete journal run Cancel journal run Stop mass action Delete Order Update order custom fields Update subscription custom fields Get an order Get order metrics for evergreen subscription Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Get rated result for order Get billing information for order Create order Update order action trigger dates Preview order Get term information for subscription Get breakdown of invoice by order Request breakdown of invoice items by order Delete payment Delete payment method Scrub payment method Create payment method Delete payment run Delete refund Update custom fields on revenue items by revenue event number Update custom fields on revenue items by revenue schedule number Delete revenue schedule Update revenue schedule basic information Delete sequence set Delete summary journal entry Cancel summary journal entry Update basic information of a summary journal entry Delete taxation item In the 200 respsonse body of the “Get job status and response” operation, added the following nested fields to the result field: processId reasons ... 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-04-18   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 243, April 2019.   Payment Methods - In the request body of the “Create payment method” operation, added the possible value ACH to the type field.   The following items are API updates specific to enhancements to the prefix and numbing configuration for billing documents. These API updates are also available as of Zuora Release 243, April 2019.   Sequence Sets - Added a new resource called “Sequence Sets”, with the following new operations: Create sequence set Get sequence sets Update sequence set Get sequence set Delete sequence set Accounts - In the request body of the following operations, added the sequenceSetId field: Create account Update account Orders - In the request body of the following operations, added the sequenceSetId nested field to the newAccount field: Create order Create order asynchronously   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, corrected the name of the subscribes > Account > Id field. Previously, the name of this field was documented as AccountId . ... 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-04-10   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Changed “customer-initiated” to “cardholder-initiated” in the following locations: The   mitProfileAction   field in the request body of the “Create payment method” operation. The   mitProfileAction   field in the request body of the “Create credit card payment method” operation. The   action   and   status   fields in the request body of the “Create stored credential profile” operation. In the request body of the “CRUD: Create Import” operation, removed the unsupported import type   MPU   from the enum values of the   ImportType   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-03-27   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the request body of the “Create account” and “Renew subscription” operations, made the following updates: Removed the unsupported version 196.0 from the description of the invoiceCollect field. Corrected the data type of the collect field from string to boolean and updated the prerequisite of this field to "The invoice or runBilling field must be true ". In the request body of the subscription-related operations listed below, made the following updates: Removed the unsupported version 196.0 from the description of the invoiceCollect field. Corrected the prerequisite of this field to "The invoice or runBilling field must be true ". The following operations are affected: Create subscription Update subscription Resume subscription Suspend subscription Cancel subscription In the Zuora Object Model section, clarified that the API name of the Billing Run object is BillingRun in Zuora Link. In the request body of the “Submit Link query” operation, made the following updates: Removed the queryType field. Changed the description of the output > target 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-03-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 242, March 2019.   Orders - Made the following updates: In the following operations, added the includeUnits field to the order (or orders ) > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageOverage field in the response body: 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 following operations, added the priceChangeOption field to the order (or orders ) > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount field in the response body: 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 following operations, added the priceChangeOption field to the order (or orders ) > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount field in the response body: 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 Payment Methods - Made the following updates: In the “Create payment method” operation, made the following updates in the request body: Added the possible value CreditCard to the type field. Added the following fields: cardHolderInfo cardNumber cardType expirationMonth expirationYear mitConsentAgreementRef mitConsentAgreementSrc mitNetworkTransactionId mitProfileAction mitProfileType securityCode In the “Create credit card payment method” operation, made the following updates in the request body: Added the possible value Persist to the mitProfileAction field. Added the mitNetworkTransactionId field. In the “Create stored credential profile” operation, added the action field in the request body. In the following operations, updated the description of the IPAddress field in the request body (or the response body) to clarify that the field has now been supported by the WorldPay payment gateway integration: CRUD: Create payment method CRUD: Update payment method CRUD: Get payment method Refunds - In the request body of the “Update refund” operation, added the referenceId 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 “Create account” operation, added reference information to the description of the creditCard > cardType field. In the request body of the “Subscribe” action, added reference information to the description of the subscribes > PaymentMethod > CreditCardType field. In the request body of the “Create credit card payment method” operation, added reference information to the description of the creditCardType field. In the request body of the following operations, added reference information to the description of the CreditCardType field: CRUD: Create payment method CRUD: Update payment method In the response body of the “Get account summary” operation, added reference information to the description of the basicInfo > defaultPaymentMethod > creditCardType field. In the response body of the “Get credit card payment methods for account” operation, added reference information to the description of the creditCards > cardType field. In the response body of the “CRUD: Get payment method” operations, added reference information to the description of the CreditCardType field. In the request body of the “Create stored credential profile” operation, clarified the description of the status field. Added a new section Link Queries containing the following operations: Submit Link query Get Link query jobs Get Link query job Cancel Link query job In the source YAML file, replaced the PostOrderDiscountPricingOverride reference object by the DiscountPricingOverride reference object. This change affects the following operations: Create order Preview order In the source YAML file, replaced the PostOrderDiscountPricingUpdate reference object by the DiscountPricingUpdate reference object. This change affects the following operations: Create order Preview order In the source YAML file, replaced the UsageOveragePricingUpdatePostOrder reference object by the UsageOveragePricingUpdate reference object. This change affects the following operations: Create order Preview order In the source YAML file, replaced the cardHolderInfo field in the POSTPaymentMethodType reference object by a new reference object called CreatePaymentMethodCardholderInfo . This change affects the “Create credit card payment method” operation. ... 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-03-13   API Updates   This section lists operations and fields that were added, changed, or removed.   The following API updates are available as of Zuora Release 240, March 2019.   Payment Methods   - Made the following updates: In the request body of the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the following enum values to the   BankTransferType   field: Autogiro Betalingsservice In the response body of the “CRUD: Get payment method” operation, added the following enum values to the   BankTransferType   field: Autogiro Betalingsservice Payment Method Snapshots   - In the response body of the “CRUD: Get payment method snapshot” operation, added the following enum values to the   BankTransferType   field: -   Autogiro -   Betalingsservice   The following API updates are available as of Zuora Release 241, March 2019.   Payment Methods   - Made the following updates: Added the following operations: Create stored credential profile Get stored credential profiles Cancel stored credential profile Expire stored credential profile In the request body of the “Create credit card payment method” operation, added the following fields: mitConsentAgreementRef mitConsentAgreementSrc mitProfileAction mitProfileType   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the missing   BankTransferType   field to the request body. In the “Get subscriptions by key” operation, corrected the description of the charge-detail query parameter. ... 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-03-07   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 240, March 2019. Payment Methods   - Made the following updates: In the request body of the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the following fields: IdentityNumber IsCompany CompanyName In the response body of the “CRUD: Get payment method” operation, added the following fields: IdentityNumber IsCompany CompanyName   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the Actions section, clarified that actions do not support the Invoice Settlement feature and the Orders feature. Also clarified this in the description of the “Query” action. ... 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-02-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 239, February 2019.   Accounts   - In the request body of the “Create account” operation, changed the behavior of the   runBilling   field to match the documentation. Previously, invoices were also generated even if   runBilling   is set to   false . Credit memos were also generated if the Invoice Settlement feature was enabled.   2019-02-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 239, February 2019.   Payments - In the request body of the “Update payment” operation, added the referenceId field. OAuth - In the “Generate an OAuth token” operation, the client_secret request body field now has a maximum supported length of 42 characters. When you create an OAuth client using the Zuora UI, the Client Secret is 38 to 42 characters long. Previously, Client Secrets were always 20 characters long. You can continue to use existing Client Secrets without modification.   The following items are API updates specific to enhancements to the Invoice Item Settlement feature:   Invoices - Made the following updates: Added a new operation “Get taxation items of invoice item”. In the response body of the “Get invoice items” operation, added the balance and taxationItems nested fields to the invoiceItems field. Credit Memos - Made the following updates: Added a new operation “Get taxation items of debit memo item”. In the “Get credit memo items” operation: Added the zuora-version request header. Added the taxationItems nested fields to the items response body field. This field is only available if you set the zuora-version request header to 239.0 or later. Changed the behavior of the items > creditTaxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later. In the “Get credit memo item” operation: Added the zuora-version request header. Added the taxationItems response body field. This field is only available if you set the zuora-version request header to 239.0 or later. Changed the behavior of the creditTaxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later. Debit Memos - Made the following updates: Added a new operation called “Get taxation items of debit memo item”. In the “Get debit memo items” operation: Added the zuora-version request header. Added the taxationItems nested field to the items response body field. This field is only available if you set the zuora-version request header to 239.0 or later. Changed the behavior of the items > taxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later. In the “Get debit memo item” operation: Added the zuora-version request header. Added the taxationItems response body field. This field is only available if you set the zuora-version request header to 239.0 or later. Changed the behavior of the taxItems response body field. This field is not available if you set the zuora-version request header to 239.0 or later.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Subscribe” action, made the following updates: Added the AccountId nested field to the subscribes > Account request body field. Removed the following nested fields from the subscribes > Account request body field: Balance BillToId CreatedById CreatedDate CreditBalance SoldToId Status UpdatedById UpdatedDate Improved the request and response samples. In the “Generate an OAuth token” operation, documented the supported length of the client_id request body field. In the “API Versions” section, added the following fields to the “Minor Version History” table: creditTaxItems taxItems taxationItems In the request body of the “Generate RSA signature” operation, removed the redundant “ zuora.com/apps/PublicHostedPageLite.do  if you are on the API Sandbox environment.” from the description of the  uri  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-02-14   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 238, February 2019.   Orders - Made the following updates: In both the “Create order” and “Preview order” operations, added the priceChangeOption field to the following fields in the request body: subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount   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 payment” operation, removed the referenceId field. In the source YAML file, duplicated the DiscountPricingOverride reference object as a new reference object called PostOrderDiscountPricingOverride that is used in the request body of the following operations: Create order Preview order In the source YAML file, duplicated the DiscountPricingUpdate reference object as a new reference object called PostOrderDiscountPricingUpdate that is used in the request body of the following operations: Create order Preview order   2019-02-12   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 238, February 2019.   Accounts - Made the following updates: In the request body of the “Generate billing documents by amount” operation, added the following fields: autoRenew chargeTypeToExclude In the response body of the “Create account” operation, added the following fields: billToContactId soldToContactId   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, corrected the descriptions of the following fields: billToContact > country billToContact > state soldToContact > country soldToContact > state In the response body of the “Get account summary” operation, corrected the descriptions of the following fields: billToContact > country billToContact > state soldToContact > country soldToContact > state In the request body of the “Create credit card payment method” operation, removed “required” from the following nested fields of the cardHolderInfo field. However, if you do not specify the accountKey  field in the request body, the  cardHolderName  field is still required . cardHolderName City State zipCode country Changed the URL of the source YAML file. See this post for more information. In the request body of the “Update payment” operation, added the  referenceId  field. However, as of Zuora Release 238, this field is not available.   ... 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-01-22   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 237, January 2019.   Subscriptions - In the following operations, added the documentDate field to the request body: creditMemo > creditMemoItems invoicceItems Product Rate Plans - In the response body of the “Get product rate plans” operation, added the following nested fields to the productRatePlans > productRatePlanCharges > financeInformation field: revRecCode revRecTriggerCondition Catalog - Made the following updates: In the response body of the “Get catalog” operation, changed the behavior of the products > productRatePlans field. In the response body of the “Get product” operation, changed the behavior of the productRatePlans field. This behavior change is available only when you set the zuora-version request header to 230.0 or later. See the descriptions of the productRatePlans fields 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 “Create debit memo from charge” operation, added the following missing fields to the charges field: serviceStartDate serviceEndDate In the “Preview order” operation, added the missing description for the previewOptions > previewTypes field in the request body. In the “Create order” operation, corrected a possible value of the subscriptions > orderActions > type field in the request body. Previously, the value Suspend was incorrectly listed as Subspend . ... 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-01-07   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 236, January 2019.   Accounts   - In the “Create account” operation, added the   documentDate   field to the request body. Subscriptions   - In the following operations, added the   documentDate   field to the request body: Create subscription Update subscription Renew subscription Cancel subscription Resume subscription Suspend subscription Invoices   - In the request body of the “Write off invoice” operation, added the following fields and support for custom fields: comment items   and its nested fields reasonCode Product Rate Plans   - In the response body of the “Get product rate plans” operation, added the following nested fields to the productRatePlans > productRatePlanCharges > financeInformation field: contractAssetAccountingCode contractAssetAccountingCodeType contractLiabilityAccountingCode contractLiabilityAccountingCodeType adjustmentLiabilityAccountingCode adjustmentLiabilityAccountingCodeType unbilledReceivablesAccountingCode unbilledReceivablesAccountingCodeType adjustmentRevenueAccountingCode adjustmentRevenueAccountingCodeType contractRecognizedRevenueAccountingCode contractRecognizedRevenueAccountingCodeType Catalog   - Made the following updates: In the “Get catalog” operation, changed the behavior of the products > productRatePlans field in the response body. In the “Get product” operation, changed the behavior of the productRatePlans field in the response body. This behavior change is available only when you set the zuora-version request header to 230.0 or later. See the descriptions of the productRatePlans fields to find out details about the latest behavior. Bill Run   - Changed the behavior of the “CRUD: Create bill run” operation. If more than 500 bill runs created by using this operation are in Pending status, no more bill runs can be created by using this operation. Payments   - Changed the behavior of the following operations. If you have the Invoice Settlement feature enabled, payments applied to credit balance cannot be canceled or deleted. Cancel payment Delete payment Refunds   - Changed the behavior of the following operations. If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be canceled or deleted. Cancel refund Delete refund   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Amend” action, corrected the descriptions of the DestinationInvoiceOwnerId and DestinationAccountId fields in the request body. In the "Suspend subscription” and “Resume subscription” operations, removed the notes about the limitation on using these operations with Order Metrics. In the “Preview order” operation, added the missing taxInfo nested field to the previewAccountInfo field in the request body. In the response bodies of the following operations, noted when  certain fields  are not applicable in the order > subscriptions > orderActions > suspend  field: Get an order Get order metrics for evergreen subscription Those fields include: suspendPolicy suspendPeriods suspendPeriodsType suspendSpecificDate In the response bodies of the following operations, noted  when  certain fields  are  not applicable in the order > subscriptions > orderActions > resume  field: Get an order Get order metrics for evergreen subscription Those fields include: resumePolicy resumePeriods resumePeriodsType resumeSpecificDate extendsTerm In the response bodies of the following operations, noted   when  certain fields  are  not applicable in the orders > subscriptions > orderActions > suspend  field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Those fields include: suspendPolicy suspendPeriods suspendPeriodsType suspendSpecificDate In the response bodies of the following operations, noted   when  certain fields  are  not applicable in the orders > subscriptions > orderActions > resume  field: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Those fields include: resumePolicy resumePeriods resumePeriodsType resumeSpecificDate extendsTerm In all relevant operations, changed the name of the Real-Time Usage Rating feature to Active Rating, and updated all related reference links. ... 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!   2018-12-14   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.   Orders - Made the following updates: In the request body of the “Create order” operation: Added nested fields called suspend and resume to the subscriptions > orderActions field. Added possible values Suspend and Resume to the subscriptions > orderActions > type field. In the response body of the “Create order” operation, added a possible value Suspended to the subscriptions > status field. In the request body of the “Preview order” operation: Added nested fields called suspend and resume to the subscriptions > orderActions field. Added possible values Suspend and Resume to the subscriptions > orderActions > type field. In the following operations, added nested fields called suspend and resume to the order > subscriptions > orderActions field of the response body: Get an order Get order metrics for evergreen subscription In the following operations, added possible values Suspend and Resume to the subscriptions > orderActions > type field of the response body: Get an order Get order metrics for evergreen subscription In the following operations, added nested fields called suspend and resume to the orders > subscriptions > orderActions field of the response body: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner In the following operations, added possible values Suspend and Resume to the orders > subscriptions > orderActions > type field of the response body: Get all orders Get orders by subscription owner Get orders by subscription number Get orders by invoice owner   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the Zuora Object Model section, added the following objects to the table of API names: Feature Product Feature Subscription Product Feature In the “Create order” operation, added a note about the Suspend and Resume feature. In the following operations, updated the note about the Orders feature: Preview order Preview order asynchronously Create order Create order asynchronously Delete order Get job status and response Update subscription custom fields Update order action trigger dates In the following operations, updated the note about the Order Metrics feature: Get all orders Get an order Get billing information for order Get term information for subscription Get order metrics for evergreen subscription Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Get breakdown of invoice by order Request breakdown of invoice items by order Get rated result for order Update order custom fields   2018-12-07   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.   Orders - Added the following new operations: Preview order asynchronously Create order asynchronously Get job status and response Accounts - Made the following updates: In the request body of the “Create account” operation, changed the behavior of the creditCard and hpmCreditCardPaymentMethodId fields. If autoPay is set to false, you do not need to specify creditCard or hpmCreditCardPaymentMethodId . Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later. In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves. In the “Create order” operation, corrected the maximum length of the following fields in the request body: newAccount > name subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > name In the “Preview order” operation, corrected the maximum length of the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > name field in the request body. ... 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!   2018-12-07   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.   Orders   - Added the following new operations: Preview order asynchronously Create order asynchronously Get job status and response Accounts - Made the following updates: In the request body of the “Create account” operation, changed the behavior of the autoPay , creditCard , and hpmCreditCardPaymentMethodId fields. If autoPay is set to false, you do not need to specify   creditCard   or   hpmCreditCardPaymentMethodId . Previously, creditCard and hpmCreditCardPaymentMethodId did not depend on autoPay . Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later. In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves. In the “Create order” operation, corrected the maximum length of the following fields in the request body: newAccount   >   name subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   name In the “Preview order” operation, corrected the maximum length of the   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   name   field in the request body. ... 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!   2018-11-15   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Create order” operation, made the following updates: Added the requirement on setting a default payment method for the newAccount field in the request body. Added the option to use the   returnIds   parameter in the endpoint so that the IDs associated with the numbers (for example,   subscriptionNumber ,   invoiceNumber , and so on) can be returned in the response. In the request body of the “Create payment” operation, updated the description of the   gatewayId   field to clarify that this field is required when creating electronic payments but optional when creating external payments. ... 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!   2018-11-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 234, November 2018.   Orders - Made the following updates: In the “Create order” operation, made the following updates to the request body: Added the includedUnits field to the subscriptions > orderActions > updateProduct > chargeUpdates > pricing field. Added the additionalEmailAddresses , customerServiceRepName , purchaseOrderNumber , salesRep , and allowInvoiceEdit fields to the following fields: newAccount subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount Added the contactDescription field to the following fields: newAccount > billToContact newAccount > soldToContact subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact Added the revRecCode , revenueRecognitionRuleName , and revRecTriggerCondition fields to the subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field. In the “Preview order” operation, made the following updates to the request body: Added the includedUnits field to the subscriptions > orderActions > updateProduct > chargeUpdates > pricing field. Added the taxInfo nested field to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field. Added the additionalEmailAddresses , customerServiceRepName , purchaseOrderNumber , salesRep , and allowInvoiceEdit fields to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field. Added the contactDescription field to the following fields: subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > billToContact subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > soldToContact Added the revRecCode , revenueRecognitionRuleName , and revRecTriggerCondition fields to the subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field. In the “Get an order” operation, added the revRecCode , revenueRecognitionRuleName , and revRecTriggerCondition fields to the order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field in the response body. In the following operations, added the contactDescription field to the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides field in the response body: Get all orders Get orders by subscription owner Get orders by subsription number Get orders by invoice owner Payment Methods - Made the following updates: Added support for custom fields in the request body of the following operations: Create payment method Create credit card payment method Update credit card payment method CRUD: Create payment method CRUD: Update payment method Added a note to the description of the accountID , accountKey , or AccountId field in the following operations to explain when the ID of customer account can be optional: Create credit card payment method Create Apple Pay payment method Update credit card payment method CRUD: Create payment method CRUD: Update payment method Accounts - Added support for custom fields to the creditCard object in the request body of the ‘‘Create account’’ operation. Notifications - Made the following updates: Added the eventTypeNamespace field to the request body of the following operations: Create a notification definition Create an email template Added the eventTypeNamespace field to the 200 response schema of the following operations: Create a notification definition Query notification definitions Update a notification definition Get a notification definition Create an email template Query email templates Update an email template Get an email template Invoices - In the response body of the “Get invoice items” operation, added the nested appliedToItemId field to the invoiceItems field. Operations - In the response body of the “Create billing preview” operation, added the nested appliedToItemId field to the following fields: invoiceItems creditMemoItems Transactions - In the response body of the “Get invoices” operation, added the nested reversed field to the invoices 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!   2018-10-26   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the description of the “Scrub payment method” operation, replaced the outdated note with the latest prerequisites of using this operation. In the “CRUD: Create payment method” and “CRUD: Update payment method” operations, added the missing parameters and removed the inapplicable ones. ... 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!   2018-10-18   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the following operations, corrected the possible values of the   status   field in the response body: Get subscriptions by key Get subscriptions by key and version Previously, the value   Pending Activation   was incorrectly listed as   PendingActivation , and the value   Pending Acceptance   was incorrectly listed as   PendingAcceptance . In the “Get subscriptions by account” operation, corrected the possible values of the   subscriptions   >   status   field in the response body. Previously, the value   Pending Activation   was incorrectly listed as PendingActivation , and the value   Pending Acceptance   was incorrectly listed as   PendingAcceptance . In the “CRUD: Retrieve Subscription” operation, corrected the possible values of the   status   field in the response body. Previously, the value   Pending Activation   was incorrectly listed as PendingActivation , and the value   Pending Acceptance   was incorrectly listed as   PendingAcceptance . In the “CRUD: Update Subscription” operation, corrected the possible values of the   status   field in the request body. Previously, the value   Pending Activation   was incorrectly listed as PendingActivation , and the value   Pending Acceptance   was incorrectly listed as   PendingAcceptance . In the “Post usage” operation, changed the following headings from required to optional. Although the values for the following headings are not required, the heardings themselves must exist in the upload CSV file. ENDDATE SUBSCRIPTION_ID CHARGE_ID At the beginning of the Accounts section, explained similar operations are provided for different use scenarios. At the beginning of the Subscription Product Features section, noted that the Entitlements feature must be enabled to use the operation. In the “CRUD: Delete amendment” operation, explained that invoiced amendments cannot usually be deleted, unless it is the last auto-renew amendment. ... 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!    2018-10-15   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 233, October 2018.   Payments   - In the request body of the “Create payment” operation, changed the   paymentMethodId   field from required to optional. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically.   2018-10-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 233, October 2018.   Orders   - Made the following updates: Added a new operation “Request breakdown of invoice items by order”. In the “Create order” operation, added the   creditMemoTemplateId   and   debitMemoTemplateId   fields to the following fields in the request body: newAccount subscription   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount Credit Memos   - Added a new operation “Request breakdown of credit memo items by order”.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the following operations, updated the notes to clarify that migration to full Orders is in   Limited Availability: Preview order Create order Delete order Update subscription custom fields Update order action trigger dates In all operations relevant to the Invoice Settlement feature, added the missing   No   enum value to the   transferredToAccounting   field. In the “Get credit memos” operation, removed the   fieldsFilterable   query parameter. This query parameter was a placeholder for the following query parameters: accountId amount appliedAmount autoApplyUponPostingbalance beAppliedAmount createdById createdDate creditMemoDate currency excludeFromAutoApplyRulesurrency debitMemoDate dueDate number referredInvoiceId refundAmount status targetDate taxAmount totalTaxExemptAmount transferredToAccounting unappliedAmount updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the “Get credit memo items” operation, removed the   fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters: amount appliedAmount createdById createdDate id refundAmount serviceEndDate serviceStartDate sku skuName sourceItemId subscriptionId updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the “Get debit memos” operation, removed the   fieldsFilterable   query parameter. This query parameter was a placeholder for the following query parameters: accountId amount balance beAppliedAmount createdById createdDate currency debitMemoDate dueDate number referredInvoiceId status targetDate taxAmount totalTaxExemptAmount updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the “Get debit memo items” operation, removed the   fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters: amount beAppliedAmount createdById createdDate id serviceEndDate serviceStartDate sku skuName sourceItemId subscriptionId updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the “Get payment runs” operation, removed the   fieldsFilterable   query parameter. This query parameter was a placeholder for the following query parameters: createdById createdDate status targetDate updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the “Get all payments” operation, removed the   fieldsFilterable   query parameter. This query parameter was a placeholder for the following query parameters: accountId amount appliedAmount createdById createdDate creditBalanceAmount currency effectiveDate number refundAmount status type unappliedAmount updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the “Get all refunds” operation, removed the   fieldsFilterable   query parameter. This query parameter was a placeholder for the following query parameters: accountId amount createdById createdDate methodType number paymentId refundDate status type updatedById updatedDate These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters. In the following operations, added   /v1   to the examples in description of the   sort   query parameter: Get all payments Get all refunds Corrected the 200 responses of the following actions: Create Execute Generate Subscribe Update Previously, each 200 response was documented as an object containing a field called   result . In the request body of the “CRUD: Create payment method” operation, and in the   subscribes   >   PaymentMethod   object in the request body of the “Subscribe” operation, made the following updates: Updated the description of the   TokenId   field to clarify that the value must be   AmazonBillingAgreementId   to create an Amazon Pay payment method. Updated the description of the   Type   field to clarify that the value must be   CreditCardReferenceTransaction   to create an Amazon Pay payment method. In the source YAML file, changed the   OrderMetricsForEvergreen   reference object from an array to an object. In the source YAML file, removed the following reference objects: ProxyActiondeleteResponse BaseObject TriggerCondition ... 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!   2018-09-28   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 232, September 2018.   Notifications   - Added the   preemptive   field to the   callout   >   calloutAuth   object in the request body of the following operations: Create a notification definition Update a notification definition And in the response body of the following operations: Query notification definitions Get a notification definition This field is used to enable preemptive authentication when Zuora makes a callout to the specified domain.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Create order” operation, corrected the names of the following request body fields: processingOptions   >   applyCreditBalance processingOptions   >   electronicPaymentOptions processingOptions   >   electronicPaymentOptions   >   paymentMethodId ... 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!   2018-09-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 order” operation, corrected the   subscriptions   >   orderActions   >   createSubscription   >   terms   >   renewalTerms   field from required to optional. ... 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!   2018-12-07   API Updates   This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 235, December 2018.   Orders   - Added the following new operations: Preview order asynchronously Create order asynchronously Get job status and response Accounts - Made the following updates: In the request body of the “Create account” operation: Added the soldToSameAsBillTo field. Changed the behavior of the autoPay , creditCard , and hpmCreditCardPaymentMethodId fields. If autoPay is set to false, you do not need to specify   creditCard   or   hpmCreditCardPaymentMethodId . Previously, creditCard and hpmCreditCardPaymentMethodId did not depend on autoPay . Changed the behavior of the “CRUD: Delete account” operation to delete accounts asynchronously. Previously, accounts were deleted synchronously when this operation is used.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Multi-entity: Disconnect connection” operation, updated the description to clarify that if you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later. In the “How this REST API Call Works” section of the “Post usage” operation, updated the description about the method for downloading the usage file template. Previously a file download link was provided in this section. Now users need to go to their tenants and download for themselves. In the “Create order” operation, corrected the maximum length of the following fields in the request body: newAccount   >   name subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   name In the “Preview order” operation, corrected the maximum length of the   subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   name   field in the request body. ... 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!   2018-09-07   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Removed the redundant   eventTypeName   field from the   filterRule   object in the request body of the “Create a notification definition” operation. The code sample was updated accordingly. ... 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!   2018-08-29   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 all orders” operation, made the following updates: Added the missing   orders   >   subscriptions   >   orderActions >   createSubscription   >   subscribeToRatePlans   >   newRatePlanId   field. Added the missing   orders   >   subscriptions   >   orderActions >   addProduct   >   newRatePlanId   field. Added the missing   orders   >   subscriptions   >   orderActions >   updateProduct   >   newRatePlanId   field. Removed the nonexistent   orders   >   subscriptions   >   orderActions   >   addProduct   >   originRatePlanId   field. Removed the nonexistent   orders   >   subscriptions   >   orderActions   >   updateProduct   >   originRatePlanId   field. Removed the nonexistent   orders   >   subscriptions   >   orderActions   >   removeProduct   >   originRatePlanId   field. In the response bodies of the following operations: Get an order Get order metrics for evergreen subscription Get orders by subscription owner Get orders by subscription number Get orders by invoice owner Made the following updates: Added the missing   order   >   subscriptions   >   orderActions >   createSubscription   >   subscribeToRatePlans   >   newRatePlanId   field. Added the missing   order   >   subscriptions   >   orderActions >   addProduct   >   newRatePlanId   field. Added the missing   order   >   subscriptions   >   orderActions >   updateProduct   >   newRatePlanId   field. Removed the nonexistent   order   >   subscriptions   >   orderActions   >   addProduct   >   originRatePlanId   field. Removed the nonexistent   order   >   subscriptions   >   orderActions   >   updateProduct   >   originRatePlanId   field. Removed the nonexistent   order   >   subscriptions   >   orderActions   >   removeProduct   >   originRatePlanId   field. In the source YAML file, replaced the   OrderActionRequest   reference object by the following new reference objects: A reference object called   CreateOrderOrderAction   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderOrderAction   that is used in the request body of the “Preview order” operation. In the source YAML file, duplicated the   CreateSubscription   reference object as the following new reference objects: A reference object called   CreateOrderCreateSubscription   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderCreateSubscription   that is used in the request body of the “Preview order” operation. A reference object called   CreateSubscriptionForEvergreen   that is used in the response body of the “Get order metrics for evergreen subscription” operation. In the source YAML file, duplicated the   RatePlanOverride   reference object as the following new reference objects: A reference object called   CreateOrderRatePlanOverride   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderRatePlanOverride   that is used in the request body of the “Preview order” operation. A reference object called   RatePlanOverrideForEvergreen   that is used in the response body of the “Get order metrics for evergreen subscription” operation. In the source YAML file, duplicated the   RatePlanUpdate   reference object as the following new reference objects: A reference object called   CreateOrderRatePlanUpdate   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderRatePlanUpdate   that is used in the request body of the “Preview order” operation. A reference object called   RatePlanUpdateForEvergreen   that is used in the response body of the “Get order metrics for evergreen subscription” operation. In the source YAML file, duplicated the   ChargeOverride   reference object as the following new reference objects: A reference object called   CreateOrderChargeOverride   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderChargeOverride   that is used in the request body of the “Preview order” operation. A reference object called   ChargeOverrideForEvergreen   that is used in the response body of the “Get order metrics for evergreen subscription” operation. In the source YAML file, duplicated the   ChargeUpdate   reference object as the following new reference objects: A reference object called   CreateOrderChargeUpdate   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderChargeUpdate   that is used in the request body of the “Preview order” operation. A reference object called   ChargeUpdateForEvergreen   that is used in the response body of the “Get order metrics for evergreen subscription” operation. In the source YAML file, duplicated the   PricingUpdate   reference object as the following new reference objects: A reference object called   CreateOrderPricingUpdate   that is used in the request body of the “Create order” operation. A reference object called   PreviewOrderPricingUpdate   that is used in the request body of the “Preview order” operation. A reference object called   PricingUpdateForEvergreen   that is used in the response body of the “Get order metrics for evergreen subscription” operation. In the source YAML file, removed the following reference objects: OrderActionAddProduct OrderActionForEvergreenAddProduct OrderActionUpdateProduct OrderActionForEvergreenUpdateProduct OrderActionRemoveProduct OrderActionForEvergreenRemoveProduct   ... 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!   2018-08-23   API Updates   This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 231, August 2018.   Catalog   - Added a new operation called “Get product”. Credit Memos   - Added a new operation called “Unpost credit memo”. Debit Memos   - Added a new operation called “Unpost debit memo”.   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 order action trigger dates” operation, made the following updates: Corrected the   subscriptions   >   subscriptionNumber   field from optional to required. Corrected the   subscriptions   >   orderActions   >   sequence   field from optional to required and clarified the description of the field. In the description of the   processPayment   request field of the “Create Apple Pay payment method” operation, clarified that if you set this field to   true , you must specify the   paymentGateway   request field with the gateway instance name. In the following operations, added   /v1   to examples in the   fieldsFilterable   and   sort   query parameters. Get credit memos Get credit memo items Get debit memos Get debit memo items ... 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!   2018-08-10   API Updates   This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 230, August 2018.   Notifications   - Removed the “Get callout options” and “Update callout options” operations. Previously, these operations caused inconsistency between API and UI. Hence, we have disabled these operations to avoid confusion. Payment Runs   - Made the following updates: In the following operations, added the   collectPayment   field to the request body: Create payment run Update payment run In the following operations, added the   collectPayment   field to the response body: Create payment run Update payment run Ger payment run In the “Get payment runs” operation, added the   collectPayment   nested field to the   paymentRuns   field in the response body. Catalog   - In the “Get product catalog” operation, made the following updates: Added the   zuora-version   parameter to header parameters. In the response body, updated the description of the   productRatePlans   field by adding version control information.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   Corrected the URL paths of the following operations: CRUD: Get amendment CRUD: Update amendment CRUD: Delete amendment The URL paths of the operations were documented as   /v1/object/amendmexnt/{id}   in versions 2018-07-18 and 2018-07-30 of the API Reference. In the “Get payment runs” operation, added   /v1   to examples in the   fieldsFilterable   and   sort   query parameters. In the “Create order” operation, corrected the names of the following request body fields: processingOptions   >   electronicPaymentOptions processingOptions   >   electronicPaymentOptions   >   paymentMethodId Previously, the field names were documented as   ElectronicPaymentOptions   and   PaymentMethodId . ... 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!   2018-07-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 following operations, added the missing   exemptEntityUseCode   nested field to the   taxInfo   field: Create account Update account In the response body of the following operations, added the missing   exemptEntityUseCode   nested field to the   taxInfo   field: Get account Get account summary In the description of the   productRatePlans   field in the response body of the “Get product catalog” operation, clarified that if you do not have product rate plan references enabled in the REST API, the value of this field is an array of product rate plan details. In the description of the “Create credit card payment method” operation, added a note to indicate that you are subject to PCI-compliance audit requirements if you are using this operation instead of the Hosted Payment Pages iFrame. ... 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!   2018-07-18   API Updates   This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 229, July 2018.   Accounts   - Added the following new operations: Create job to hard delete billing document files Get job of hard deleting billing document files Catalog   - In the “Multi-entity: Share a Product with an Entity” operation, made the following updates: Changed the HTTP method from “PUT” to “POST” in order to eliminate misunderstanding. In the source file, changed the value of the   operationId   field from   PUT_Catalog   to   POST_Catalog , and renamed the   PUTCatalogType   reference object to   POSTCatalogType . Credit Memos   - The “Create credit memo PDF” operation now depends on the Billing user permission “Regenerate PDF”. The operation description explains more details. Debit Memos   - The “Create debit memo PDF” operation now depends on the Billing user permission “Regenerate PDF”. The operation description explains more details.   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Amend” action, made the following updates: Updated the description of the action to clarify the order in which Zuora modifies the subscription. Improved the JSON request sample. Removed the “CRUD: Create amendment” operation. This operation has significant limitations and Zuora recommends that you use the “Update subscription” operation or the “Amend” action instead. In the response body of the following operations, corrected the format of the   order   >   createdDate   and   order   >   updatedDate   fields to   datetime : Get an order Get order metrics for evergreen subscription In the response body of the following operations, corrected the format of the   orders   >   createdDate   and   orders   >   updatedDate   fields to   datetime : 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. 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!   2018-07-11   API Updates   This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 228, July 2018.   Catalog   - In the “Get catalog” operation, changed the behavior of   the   productRatePlans   field   in the response body. When you call this operation, a URL is returned as the value of   the   productRatePlans   field, instead of product rate plan details. The URLs correspond to the new “Get product rate plans” call. See the descriptions of   the   productRatePlans   fields   to find out how to enable the latest behavior in your tenant. Product Rate Plans   - Added a new operation called “Get product rate plans”.   Doc Updates   In the “Amend” action, made the following updates: Updated the description of the operation to clarify that the operation cannot be used to amend multiple subscriptions. Added a description for   the   requests   field   in the request body. Correctly documented which Amendment object fields are required. Previously, the operation description and the request body listed different Amendment object fields as required. 2018-07-05   API Updates   This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 228, July 2018.   Payment Methods   - Made the following updates to the "Create payment method" operation: In the operation description, updated the different fields specific to each payment method type. In the   type   field, added the support for the   PayPalNativeEC   and   PayPalAdaptive  values. Changed the   BAID   and   email   fields from required to optional because these fields are conditionally required, and updated the corresponding description. Added the   preapprovalKey   field for the PayPal Adaptive payment method. Transactions   - In the “Get invoices” operation, changed the behavior of the   invoiceItems   and   invoiceFiles   fields in the response body. When you call this operation, URLs are returned as the values of the   invoiceItems   and   invoiceFiles   fields, instead of invoice item details and invoice file details. The URLs correspond to the “Get invoice items” and “Get invoice files” operations. See the descriptions of the   invoiceItems   and   invoiceFiles   fields to find out how to enable the latest behavior in your tenant. Orders   - In the request body of the “Create order” operation, added the   customFields   container to the following fields: newAccount   >   billToContact newAccount   >   soldToContact subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   billToContact subscriptions   >   orderActions   >   createSubscription   >   newSubscriptionOwnerAccount   >   soldToContact   Doc Updates   This section lists the documentation updates that were made in this version of the API Reference.   In the “Create order” operation, added a note about payment processing failures. In all relevant operations, changed the name of the Advanced AR Settlement feature to Invoice Settlement, and updated all related reference links. ... View more