Happy Business Starts Here

Zuora Documentation

Re: API Changelog

 

2017-11-08

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the November 2017 release, R218.

 

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Added the Payment Run object to the listing of API names in the Zuora Object Model section.
  • In the "Create credit memo from invoice" and "Create debit memo from invoice" operations, added the missing taxAutoCalculation field to the request body.
  • In the “Invoice and collect” operation, clarified that when you leave the invoiceId field empty, payment is collected not only on the generated invoices, but also on any other unpaid invoice of that customer.
Zuora Documentation

Re: API Changelog

2017-11-15

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Added the following operations that are part of the Orders feature:
    • Preview order
    • Create and activate order
    • Delete order
    • Update order custom fields
    • Update subscription custom fields
  • Added notes in the descriptions of the following operations that are restricted by the Orders feature:
    • Preview subscription
    • Create subscription
    • Update subscription
    • Renew subscription
    • Cancel subscription
    • Suspend subscription
    • Resume subscription
    • Create account
    • Subscribe
    • Amend
    • CRUD: Update subscription
    • CRUD: Delete subscription
    • CRUD: Create amendment
    • CRUD: Update amendment
    • CRUD: Delete amendment
  • In operations that return order actions, added the missing discount field in the updateProduct > chargeUpdates > pricing object. The responses of the following operations have been updated:
    • Get all orders
    • Get an order
    • Get order metrics for evergreen subscriptions
    • Get orders by invoice owner
    • Get orders by subscription owner
    • Get orders by subscription number

    In the responses of the same operations, added descriptions of the following fields:

    • addProduct > chargeOverrides > pricing > discount > discountAmount
    • addProduct > chargeOverrides > pricing > discount > discountPercentage
Zuora Documentation

Re: API Changelog

2017-12-06

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the December 2017 release, R219.

 

  • HMAC Signatures - Fixed CORS issue using the new REST APIs via API proxy. Now you can sign and make CORS enabled requests with URI like https://rest.zuora.com/v1/payment-methods/credit-cards as documented to return signature and token in addition to https://api.zuora.com/rest/v1/payment-methods/credit-cards.
  • Payment Runs - Added a new resource "Payment Runs" and the following new operations:
    • Create payment run
    • Update payment run
    • Delete payment run
    • Get payment run
    • Get payment runs
    • Get payment run summary
  • Invoices - Added the following new operations:
    • Update invoice
    • Update invoices
  • Debit Memos - Made the following updates:
    • Added a new operation "Update debit memos".
    • In the "Update debit memo" operation, added the dueDate field to the request body.
  • Orders - Added a new operation "Get term information for subscription".

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Removed the 400 response and the Errors > Field field in the 200 response of the following operations:
    • Amend
    • Create
    • Execute
    • Generate
    • Subscribe
    • Update
  • Removed the 400 response and the errors Field field in the 200 response of the "Delete" operation.
  • Removed the 400 response of the "Query" and "QueryMore" operations.
  • In the "Query" operation, added links to information about Zuora Object Query Language (ZOQL). Also noted that when querying one-time charges from ProductRatePlanCharge, you need to specify the ChargeType value as One-Time rather than OneTime.
  • In the "Subscribe" operation, clarified that the Account object cannot be updated.
  • Added a missing operation "CRUD: Create Import".
  • For Orders operations and the "Update subscription custom fields" operation, corrected the description of the success field. Previously, the description of the success field incorrectly referred to Order creation for some operations.
  • In the “Create subscription” operation, corrected the values of the subscribeToRatePlans > chargeOverrides > billCycleType field. Changed SpecificDayOfWeek to SpecificDayofWeek, and SpecificDayOfMonth to SpecificDayofMonth.
  • In the “Update subscription” operation, corrected the values the of add > chargeOverrides > billCycleType field. Changed SpecificDayOfWeek to SpecificDayofWeek, and SpecificDayOfMonth to SpecificDayofMonth.
  • Clarified the value of “expirationMonth” field is in one or two digits in the following operations:
    • Update payment method
    • Get payment method
    • Create payment method
Zuora Documentation

Re: API Changelog

2018-01-17

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the January 2018 release, R220.

 

  • Invoices - Made the following updates:
    • Added a new operation “Get invoice application parts”.
    • In the "Update invoice" operation, added the autoPay field to the request body and response body.
    • In the "Update invoices" operation, added the autoPay field to the request body.
  • Debit Memos - Added a new operation "Get debit memo application parts".
  • Payment Runs - Made the following updates:
    • In the "Get payment run summary" operation, added the following fields to the response body:
      • numberOfCreditBalanceAdjustments
      • numberOfInvoices
      • numberOfUnprocessedInvoices
      • numberOfCreditMemos
      • numberOfDebitMemos
      • numberOfUnappliedPayments
      • numberOfUnprocessedDebitMemos
    • In the "Get payment run summary" operation, added the following nested fields to the totalValues field in the response body:
      • totalValueOfCreditBalance
      • totalValueOfInvoices
      • totalValueOfUnprocessedInvoices
      • totalValueOfDebitMemos
      • totalValueOfCreditMemos
      • totalValueOfUnappliedPayments
      • totalValueOfUnprocessedDebitMemos
  • Mass Updater - In the "Perform mass action" operation, added a value MPU to the params > actionType field in the request body.

 

Doc Updates

 

  • In the code samples of all operations, replaced the authentication scheme using username and password with OAuth v2.0 using bearer token.
  • Changed the entityId and entityName to Zuora-Entity-Ids in the request headers for forward compatibility.
  • In the Zuora Object Model section, corrected the API name of the Billing Run object to BillRun. Previously, the API name was incorrectly listed as BillingRun.
  • In the "CRUD: Get payment" and "CRUD: Update payment" operations, corrected the valid values of the TransferredToAccounting field in the response body. The value Yes was incorrectly displayed as true.
  • In the "CRUD: Retrieve PaymentMethodSnapshot" operation, corrected the valid values of the ExistingMandate field in the response body. The values Yes and No were incorrectly displayed as true and false.
  • Added the missing /v1/ in the URL path to the following operations:
    • Create payment run
    • Get payment runs
    • Update payment run
    • Get payment run
    • Delete payment run
    • Get payment run summary
  • Removed incorrect code samples for the following operations:
    • Generate an OAuth token
    • Add attachments
    • Perform mass action
    • Post usage
    • CRUD: Create Import
    The Curl samples for these operations are correct.
  • Corrected the request content type and parameters of the following operations:
    • Add attachments
    • Perform mass action
    • Post usage
    The request content type for these operations is multipart/form-data with formData parameters. Previously, the request content type was incorrectly documented as application/json with request body parameters.
  • In the "Post usage" operation, corrected the description and example of the checkImportStatus response field. Previously, the checkImportStatus field was documented as being a full URL, including the hostname.
  • Changed the Error reference object name to ActionsErrorResponse in the source YAML file.
  • In the "Get payment runs" operation, corrected the items field name to paymentRuns in the response body.
  • In the following operations, updated the descriptions of the autoApplyCreditMemo and autoApplyUnappliedPayment fields in the request body and response body:
    • Create payment run
    • Update payment run
  • In the following operations, updated the descriptions of the autoApplyCreditMemo and autoApplyUnappliedPayment fields in the response body:
    • Get payment runs
    • Get payment runs
    • Get payment run summary
  • In the source YAML file, corrected the operationId property for the following operations:
    • Delete payment run
    • Get payment run summary
  • In the “Introduction” section, added a link to the API feedback form in the Zuora Community.
  • In the “QueryMore” operation, added the missing required queryLocator field in the request code samples.
  • In the "Query" operation, added the missing conf object in the request body.
  • In the “Other Supported Authentication Schemes” section, added a link to the Connections section.
  • Removed the confusing sentence "A call to connections is a required first step before using the Zuora REST API to access data" in the description of the “Establish connection to Zuora REST API service” operation.
  • Corrected the name of the “Create payment method decryption” operation to “Create Apple Pay payment method”.
  • In the "Create subscription" operation, updated the description of the subscribeToRatePlans > chargeOverrides > quantity field in the request body.
  • Moved the "Get breakdown of invoice by order" operation and the "Update subscription custom fields" operation to the Orders section of the API Reference.
  • In the Orders operations, changed the CommonResponse reference object name to CommonResponseType in the source YAML file.
  • In the "Create and activate order" operation, added the missing autoPay nested field to the newAccount field in the request body.
  • For Orders operations and the "Update subscription custom fields" operation, removed the customField__c field from customFields objects. The structure of customFields objects is now correct in the source YAML file, and the description of customFields objects now explains the correct structure. Also in the source YAML file, changed the name of the corresponding reference object from CustomFields to ObjectCustomFields.

 

Zuora Documentation

Re: API Changelog

2018-02-07

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the February 2018 release, R221.

 

  • Credit Memos - Made the following updates:
    • In the “Create taxation items for credit memo” operation, added the customField__c nested field to the taxationItems field in the request body and response body.
    • In the “Update credit memo” operation, added the customField__c nested field to the items field in the request body.
    • In the “Get credit memo items” operation, added the customField__c nested field to the items field in the response body.
    • In the “Get credit memo item” operation, added the customField__c field to the response body.
  • Debit Memos - Made the following updates:
    • In the following operations, added the autoPay field to the request body and response body:
      • Create debit memo from charge
      • Update debit memo
    • In the “Get debit memos” operation, added the autoPay nested field to the debitmemos field in the response body.
    • In the following operations, added the autoPay field to the response body:
      • Get debit memo
      • Cancel debit memo
      • Post debit memo
    • In the “Update debit memo” operation, added the autoPay field to the request body and response body, and added the customField__c nested field to the items field in the request body.
    • In the “Create taxation items for debit memo” operations, added the customField__c nested field to the taxationItems field in the request body and response body.
    • In the “Get debit memo items” operation, added the customField__c nested field to the items field in the response body.
    • In the “Get debit memo item” operation, added the customField__c field to the response body.
  • Invoices - Made the following updates:
    • In the “Create debit memo from invoice” operation, added the autoPay field to the request body and response body.
    • In the following operations, added the customField__c nested field to the items field in the request body.
      • Create credit memo from invoice
      • Create debit memo from invoice
  • Taxation Items - Made the following updates:
    • In the “Update taxation item” operation, added the customField__c field to the request body and response body.
    • In the “Get taxation item” operation, added the customField__c field to the response body.
  • Orders - In the "Create and activate order" operation, added the newSubscriptionOwnerAccount field and its nested fields to the Subscriptions > OrderActions > createSubscription field in the request body.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Added the missing /v1/ in the URL path of the following operations:
    • CRUD: Retrieve PaymentMethodSnapshot
    • CRUD: Delete PaymentMethodSnapshot
  • Removed the trailing slash from the URL of the "Get revenue schedule by invoice item adjustment" operation.
  • In the “Create Apple Pay payment method” operation, added a note to interpret that when you set the processPayment field to false, you must select the Verify new credit card check box on the gateway instance setting page.
  • In the “Actions” section:
    • Added a note that Actions do not support Advanced AR Settlement feature.
    • Added a description that you can use the X-Zuora-WSDL-Version field in the request header to change the WSDL version.
Highlighted
Zuora Documentation

Re: API Changelog

2018-02-27

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Changed the name of the "Usage (with Real-Time Rating)" section. This section was originally called Usage Rating.

 

2018-02-23

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the February 2018 production release, R221.

 

  • Usage (with Real-Time Rating) - Added operations provided by the new Real-Time Usage Rating service.
  • Subscriptions - Made the following updates:
    • Added a value ByGroupId to the ratingGroup field in the request body of the following operations:
      • Create subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
      • Preview subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
      • Update subscription: add > chargeOverrides > ratingGroup
    • Added a value ByGroupId to the ratingGroup field in the response body of the following operations:
      • Get subscriptions by account: subscriptions > ratePlans > ratePlanCharges > ratingGroup
      • Get subscriptions by key: ratePlans > ratePlanCharges > ratingGroup
      • Get subscriptions by key and version: ratePlans > ratePlanCharges > ratingGroup
  • Accounts - In the “Create account” operation, added a value ByGroupId to the subscriptions > subscribeToRatePlans > chargeOverrides > ratingGroup field in the request body.
  • Catalog - In the “Get product catalog” operation, added a value ByGroupId to the products > productRatePlans > productRatePlanCharges > ratingGroup field in the response body.
  • Custom Fields - Added operations provided by the new Custom Fields service.
  • Actions and CRUD operations - Added the WWW-Authenticate header to the 401 response of each operation. This update is available in the Zuora API Sandbox environment. As of 2018-02-23, this update is not yet available in the Zuora Production environment.

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • In the “Create and activate order” operation, added links to tutorials that demonstrate how to use the operation.
  • In the “Get account summary” operation, added a note to the usage field in the response body, noting that usage data is not returned if the Real-Time Usage Rating feature is enabled.
  • Set "example.com" as the domain in all sample email addresses.
  • In the "Orders" section, removed the unnecessary regular expressions from the communicationProfileId, hpmCreditCardPaymentMethodId, and invoiceTemplateId fields.
  • In the “CRUD: Create Bill Run” operation, corrected ChargeTypeToExclued to ChargeTypeToExclude in code samples.

 

Zuora Documentation

Re: API Changelog

 

2018-03-21

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the March 2018 production release, R222.

 

  • Added the Event Triggers and Notification sections.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Removed the Notification History section. The operations previously in this section are now in the Notification section.

 

2018-03-16

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the March 2018 release, R222.

 

  • Orders - Made the following updates:
    • In the “Preview order” operation, added a new orderItems field and its nested fields to the previewResult > orderMetrics > orderActions field in the response body.
    • In the “Preview order” operation, added a new elp field and its nested fields to the previewResult > orderMetrics > orderActions > orderMetrics field in the response body.
    • In the “Preview order” operation, added new orderItemId and generatedReason fields to the previewResult > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) field in the response body.
    • In the following operations, added a new orderItems field and its nested fields to the orders > subscriptions > orderActions field in 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 a new elp field and its nested fields to the orders > subscriptions > orderActions > orderMetrics field in 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 new orderItemId and generatedReason fields to the orders > subscriptions > orderActions > orderMetrics > mrr (and quantity, tcb, tcv) field in the response body:

      • Get all orders

      • Get orders by subscription owner

      • Get orders by subscription number

      • Get orders by invoice owner

    • In the “Get an order” operation, added a new orderItems field and its nested fields to the order > subscriptions > orderActions field in the response body.

    • In the “Get an order” operation, added a new elp field and its nested fields to the order > subscriptions > orderActions > orderMetrics field in the response body.

    • In the “Get an order” operation, added new orderItemId and generatedReason fields to the order > subscriptions > orderActions > orderMetrics > mrr (and quantity, tcb, tcv) field in the response body.

    • In the “Get breakdown of invoice by order” operation, added the following new fields to the breakdowns > breakdownDetails field in the response body:

      • orderItemId
      • orderActionId
      • startDate
      • endDate
      • generatedReason
  • Credit Memos - Made the following updates:
    • In the “Get breakdown of credit memo by order” operation, added the following nested fields to the breakdowns > breakdownDetails field in the response body:
      • orderItemId
      • orderActionId
      • startDate
      • endDate
      • generatedReason
    • In the “Create credit memo from charge” operation, added the customField__c nested field to the items field in the request body.
  • Debit Memos - In the “Create credit memo from charge” operation, added the customField__c nested field to the items field in the request body.
  • Invoices - In the following operations, added the customField__c nested field to the items field in the request body. This has been documented in the v2018-02-07 API changelog.
    • Create credit memo from invoice
    • Create debit memo from invoice
  • Describe - In the “Describe object” operation, added the response code 404 and the corresponding description. Previously, it returned 500 if the requested object did not exist and was not documented.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • In the “Preview order” operation, added the missing subscriptionOwner and invoiceOwner fields to the previewResult > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) response field.

  • In the following operations, added the missing createdDate, createdBy, updatedDate, and updatedBy fields to the orders field in 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 the missing customFields field to the orders > subscriptions field in 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 the missing subscriptionOwner and invoiceOwner fields to the orders > subscriptions > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) fields in the response body:

    • Get all orders

    • Get orders by subscription owner

    • Get orders by subscription number

    • Get orders by invoice owner

  • In the “Get an order” operation, added the missing createdDate, createdBy, updatedDate, and updatedBy fields to the order field in the response body.

  • In the “Get an order” operation, added the missing customFields field to the order > subscriptions field in the response body.

  • In the “Get an order” operation, added the missing subscriptionOwner and invoiceOwner fields to the order > subscriptions > orderMetrics > orderActions > orderMerics > mrr (and quantity, tcb, tcv) fields in the response body.

  • In the “Create and activate order” operation, updated the description of the existingAccountNumber and accountNumber fields to clarify these fields specify the invoice owner of the subscriptions in the order

  • Updated the JSON response samples in the following operations:

    • Preview order

    • Get all orders

    • Get an order

    • Get orders by subscription owner

    • Get orders by subscription number

    • Get orders by invoice owner

    • Get breakdown of invoice by order

  • Corrected links to Order Metrics documentation.

  • Added the Order ELP and Order Item objects to the listing of API names in the Zuora Object Model section.

  • In the YAML source for the “Get order metrics for evergreen subscription” operation, renamed the following reference objects:

    • GetOrderResponse

    • Order

    • OrderAction

    • OrderMetrics

    • TimeSlicedMetrics

    • TimeSlicedNetMetrics

    • TimeSlicedTcbNetMetrics

    The names of the reference objects now end with “ForEvergreen”. For instance, GetOrderResponseForEvergreen, and so on.

  • Removed the “Custom Fields” and “Usage (with Real-Time Rating)” sections.
  • In the following operations, added detailed descriptions to each value of the source field and updated the sourceId field description in the response body:
    • Create credit memo from charge
    • Create credit memo from invoice
    • Get credit memo
    • Get credit memos
    • Update credit memo
    • Apply credit memo
    • Unapply credit memo
    • Cancel credit memo
    • Post credit memo
    • Query credit memos by account
  • In the description of the ratingGroup field in the request body of the following operations, noted that the ByGroupId value is only available if you have Real-Time Usage Rating feature enabled:
    • Create account: subscriptions > subscribeToRatePlans > chargeOverrides > ratingGroup
    • Create subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
    • Preview subscription: subscribeToRatePlans > chargeOverrides > ratingGroup
    • Update subscription: add > chargeOverrides > ratingGroup
  • In the description of the ratingGroup field in the response body of the following operations, noted that the ByGroupId value is only available if you have Real-Time Usage Rating feature enabled:
    • Get subscriptions by account: subscriptions > ratePlans > ratePlanCharges > ratingGroup
    • Get subscriptions by key: ratePlans > ratePlanCharges > ratingGroup
    • Get subscriptions by key and version: ratePlans > ratePlanCharges > ratingGroup
    • Get product catalog: products > productRatePlans > productRatePlanCharges > ratingGroup
  • In the “Get account summary” operation, updated the description of the usage field in the response body.
  • In the “CRUD: Create Payment Method” operation, added the missing CreditCardNumber and CreditCardSecurityCode fields in the request body.
  • In the description of the “itempartid” parameter of the “Get payment part item” operation, corrected the “Get payment part items” operation link from https://www.zuora.com/developer/api-reference/#operation/GET_PayemntItemParts to https://www.zuora.com/developer/api-reference/#operation/GET_PaymentItemParts.
  • In the “Get revenue schedule by invoice item adjustment” operation, changed the endpoint parameter “{invoice-item-adj-id}” to “{invoice-item-adj-key}” to be more accurate and in line with the OpenAPI 2.0 specification.
  • In the Endpoint section, added a note that you need to contact Zuora Global Support to enable REST API in Services environments.
  • In the "Query" operation, corrected the type of the batchSize field from “Integer” to “integer”.

 

Zuora Documentation

Re: API Changelog

2018-04-16

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the April 2018 release, R223.

 

  • Orders - Made the following updates:
    • Added a new operation “Update order action trigger dates”.
    • In the "Create order" operation, added a new field status in the response body.
    • In the response body of the "Create order" operation, replaced the scriptionNumbers field by the subscriptions field and its nested fields.
    • In the response body of the "Get an order" operation, added a new value Pending to the Order > status field.
    • In the response bodies of the following operations, added a new value Pending to the Orders > status field:
      • Get all orders
      • Get orders by subscription owner
      • Get orders by subscription number
      • Get orders by invoice owner
    • In the response body of the "Create order" operation, added a new field ElectronicPaymentOptions and its nested fields to the processingOptions field.
    • In the response body of the "Create order" operation, added a new field parentId to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount field.
  • Payment Methods - Added new operations “Create Authorization” and “Cancel Authorization”.
  • OAuth - Made the following updates to the “Generate an OAuth token” operation:
    • Implemented rate limiting by IP address and added the corresponding 429 response code.
    • Added new response headers X-RateLimit-Limit-minute and X-RateLimit-Remaining-minute.
  • Event Triggers - In the “Create an event trigger” operation, added the Order and OrderAction objects to the list of supported objects.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Corrected the endpoints of several Notification operations. Previously, the endpoints /notifications/email-templates and /notifications/callout-options were incorrectly documented as /notification/email-templates and /notification/callout-options.
  • In the “Create an event trigger” operation, modified the note that the number of event triggers you can create depends on the edition of Zuora platform you are using.
  • Added quantity limitations to the descriptions of the following operations:
    • Apply credit memo
    • Unapply credit memo
    • Create payment
    • Apply payment
  • Made the following updates to Orders operations:
    • Renamed the "Create and activate order" operation to "Create order".
    • Updated the description of the subscriptions > orderActions > triggerDates field in the request body of the "Create order" operation.
    • Updated the description of the subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate field in the request body of the "Create order" operation.
    • Updated the description of the orderNumber field in the response body of the "Create order" operation.
    • Updated the request sample for the "Create order" operation. The request sample now includes the pending order and subscription feature.
    • Updated the response sample of the "Create order" operation. The response sample now includes the pending order and subscription feature.
    • In several operations, improved the documentation of the createSubscription order action so that the purpose of each field is more clearly explained.
  • Removed the following nonexistent fields from the request bodies of the “Preview subscription”, “Renew subscription”, and “Cancel subscription” operations:
    • OpportunityCloseDate_QT
    • OpportunityName_QT
    • QuoteBusinessType_QT
    • QuoteNumber_QT
    • QuoteType_QT
  • Added fields provided by the Zuora Connector for NetSuite. The names of these fields end with __NS. The following Zuora business objects have fields provided by the Zuora Connector for NetSuite:
    • Account
    • Credit Balance Adjustment
    • Credit Memo
    • Debit Memo
    • Invoice
    • Invoice Item
    • Payment
    • Product
    • Product Rate Plan
    • Product Rate Plan Charge
    • Refund
    • Subscription
  • Made the following changes to improve the structure of the source YAML file:
    • Removed the BigDecimal format from numerical fields.
    • Changed the TriggerDates reference object from an array to an object and renamed it TriggerDate.
    • Replaced the ObjectCustomFields reference object by new reference objects corresponding to different Zuora business objects. For example, the new RatePlanChargeObjectCustomFields reference object represents custom fields of a Rate Plan Charge object.
    • Merged the newSubscriptionOwnerAccount reference object into the CreateSubscription reference object.
    • Merged the Terms reference object into the CreateSubscription reference object.
    • Merged the InitialTerm reference object into the CreateSubscription reference object.
    • Merged the PricingOverride reference object into the ChargeOverride reference object.
    • Merged the BillingOverride reference object into the ChargeOverride reference object.
    • In the OrderActionForEvergreen reference object, replaced the addProduct, updateProduct, and removeProduct nested fields by references to new reference objects called OrderActionForEvergreenAddProduct, OrderActionForEvergreenUpdateProduct, and OrderActionForEvergreenRemoveProduct.
    • In the OrderAction reference object, replaced the addProduct, updateProduct, and removeProduct nested fields by references to new reference objects called OrderActionAddProduct, OrderActionUpdateProduct, and OrderActionRemoveProduct.
  • In the source YAML file, replaced placeholder fields called customField__c by reference objects that correctly represent custom fields. Each new reference object represents custom fields of a Zuora business object. For example, the new RatePlanChargeObjectCustomFields reference object represents custom fields of a Rate Plan Charge object.

    These changes affect the following reference objects:

    • AmendmentRatePlanChargeDataRatePlanCharge (new reference object; previously part of AmendmentRatePlanChargeData)
    • CreatePaymentType
    • CreditMemoFromChargeDetailType
    • CreditMemoFromChargeType
    • CreditMemoFromInvoiceType
    • CreditMemoItemFromInvoiceItemType
    • DebitMemoFromChargeDetailType
    • DebitMemoFromChargeType
    • DebitMemoFromInvoiceType
    • DebitMemoItemFromInvoiceItemType
    • EventRevenueItemType
    • GETARPaymentType
    • GETARPaymentTypewithSuccess
    • GETAccountSummarySubscriptionType
    • GETAccountSummaryTypeBasicInfo (new reference object; previously part of GETAccountSummaryType)
    • GETAccountSummaryTypeBillToContact (new reference object; previously part of GETAccountSummaryType)
    • GETAccountSummaryTypeSoldToContact (new reference object; previously part of GETAccountSummaryType)
    • GETAccountTypeBasicInfo (new reference object; previously part of GETAccountType)
    • GETAccountTypeBillToContact (new reference object; previously part of GETAccountType)
    • GETAccountTypeSoldToContact (new reference object; previously part of GETAccountType)
    • GETAccountingCodeItemType
    • GETAccountingCodeItemWithoutSuccessType
    • GETAccountingPeriodType
    • GETAccountingPeriodWithoutSuccessType
    • GETCreditMemoItemType
    • GETCreditMemoItemTypewithSuccess
    • GETCreditMemoType
    • GETCreditMemoTypewithSuccess
    • GETDebitMemoItemType
    • GETDebitMemoItemTypewithSuccess
    • GETDebitMemoType
    • GETDebitMemoTypewithSuccess
    • GETInvoiceType
    • GETInvoicesInvoiceItemType
    • GETJournalEntryDetailType
    • GETJournalEntryDetailTypeWithoutSuccess
    • GETJournalEntryItemType
    • GETPaymentType
    • GETProductRatePlanChargeType
    • GETProductRatePlanType
    • GETProductType
    • GETRSDetailForProductChargeType
    • GETRSDetailType
    • GETRSDetailWithoutSuccessType
    • GETRefundCreditMemoType
    • GETRefundPaymentType
    • GETRefundType
    • GETRefundTypewithSuccess
    • GETRevenueEventDetailType
    • GETRevenueEventDetailWithoutSuccessType
    • GETRevenueItemType
    • GETRsRevenueItemType
    • GETSubscriptionRatePlanChargesType
    • GETSubscriptionRatePlanType
    • GETSubscriptionType
    • GETSubscriptionTypeWithSuccess
    • GETTaxationItemType
    • GETTaxationItemTypewithSuccess
    • GETUsageType
    • GetProductFeatureType
    • InvoiceDataInvoice (new reference object; previously part of InvoiceData)
    • InvoiceItem
    • POSTAccountType
    • POSTAccountTypeBillToContact (new reference object; previously part of POSTAccountType)
    • POSTAccountTypeSoldToContact (new reference object; previously part of POSTAccountType)
    • POSTAccountTypeSubscription (new reference object; previously part of POSTAccountType)
    • POSTAccountingCodeType
    • POSTAccountingPeriodType
    • POSTJournalEntryItemType
    • POSTJournalEntryType
    • POSTRevenueScheduleByChargeType
    • POSTRevenueScheduleByChargeTypeRevenueEvent (new reference object; previously part of POSTRevenueScheduleByChargeType)
    • POSTRevenueScheduleByDateRangeType
    • POSTRevenueScheduleByDateRangeTypeRevenueEvent (new reference object; previously part of POSTRevenueScheduleByDateRangeType)
    • POSTRevenueScheduleByTransactionRatablyType
    • POSTRevenueScheduleByTransactionRatablyTypeRevenueEvent (new reference object; previously part of POSTRevenueScheduleByTransactionRatablyType)
    • POSTRevenueScheduleByTransactionType
    • POSTRevenueScheduleByTransactionTypeRevenueEvent (new reference object; previously part of POSTRevenueScheduleByTransactionType)
    • POSTScCreateType
    • POSTSrpCreateType
    • POSTSubscriptionPreviewTypePreviewAccountInfo (new reference object; previously part of POSTSubscriptionPreviewType)
    • POSTSubscriptionType
    • POSTTaxationItemForCMType
    • POSTTaxationItemForDMType
    • PUTAccountType
    • PUTAccountTypeBillToContact (new reference object; previously part of PUTAccountType)
    • PUTAccountTypeSoldToContact (new reference object; previously part of PUTAccountType)
    • PUTAccountingCodeType
    • PUTAccountingPeriodType
    • PUTAllocateManuallyType
    • PUTCreditMemoItemType
    • PUTCreditMemoType
    • PUTDebitMemoItemType
    • PUTDebitMemoType
    • PUTJournalEntryItemType
    • PUTRSBasicInfoType
    • PUTRSTermType
    • PUTRefundType
    • PUTScAddType
    • PUTScUpdateType
    • PUTSpecificDateAllocationType
    • PUTSrpAddType
    • PUTSrpUpdateType
    • PUTSubscriptionType
    • PUTTaxationItemType
    • PUT_BasicSummaryJournalEntryType
    • PostNonRefRefundType
    • PostRefundType
    • ProxyCreateAccount
    • ProxyCreateAmendment
    • ProxyCreateContact
    • ProxyCreateInvoiceAdjustment
    • ProxyCreatePayment
    • ProxyCreateProduct
    • ProxyCreateProductRatePlan
    • ProxyCreateRefund
    • ProxyCreateTaxationItem
    • ProxyCreateUsage
    • ProxyGetAccount
    • ProxyGetAmendment
    • ProxyGetContact
    • ProxyGetCreditBalanceAdjustment
    • ProxyGetFeature
    • ProxyGetInvoice
    • ProxyGetInvoiceAdjustment
    • ProxyGetInvoiceItem
    • ProxyGetInvoiceItemAdjustment
    • ProxyGetPayment
    • ProxyGetProduct
    • ProxyGetProductFeature
    • ProxyGetProductRatePlan
    • ProxyGetProductRatePlanCharge
    • ProxyGetRatePlan
    • ProxyGetRatePlanCharge
    • ProxyGetRefund
    • ProxyGetSubscription
    • ProxyGetSubscriptionProductFeature
    • ProxyGetTaxationItem
    • ProxyGetUsage
    • ProxyModifyAccount
    • ProxyModifyAmendment
    • ProxyModifyContact
    • ProxyModifyInvoice
    • ProxyModifyInvoiceAdjustment
    • ProxyModifyPayment
    • ProxyModifyProduct
    • ProxyModifyProductRatePlan
    • ProxyModifyRefund
    • ProxyModifySubscription
    • ProxyModifyTaxationItem
    • ProxyModifyUsage
    • PutInvoiceResponseType
    • RatePlanChargeDataRatePlanCharge (new reference object; previously part of RatePlanChargeData)
    • RatePlanDataRatePlan (new reference object; previously part of RatePlanData)
    • RevenueScheduleItemType
    • SubscribeRequestAccount (new reference object; previously part of SubscribeRequest)
    • SubscribeRequestBillToContact (new reference object; previously part of SubscribeRequest)
    • SubscribeRequestSoldToContact (new reference object; previously part of SubscribeRequest)
    • SubscribeRequestSubscriptionDataSubscription (new reference object; previously part of SubscribeRequest)
    • SubscriptionProductFeature
    • UpdatePaymentType

    See Advance notice of change to custom field support in the Zuora Swagger spec for information about the impact of these changes.

 

Zuora Documentation

Re: API Changelog

2018-04-24

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed.

 

  • Actions - Made the following updates to all operations:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Added a new Zuora-Request-Id response header.
  • Made the following updates to all CRUD operations:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Added a new Zuora-Request-Id response header.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Improved the Introduction section by clarifying information about accessing the API and removing redundant information.

  • Improved the Curl request sample for the “Get files” operation.

 

2018-04-22

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the April 2018 production release, R223.

 

  • OAuth - Made the following updates to the “Generate an OAuth token” operation:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead. The Zuora-Request-Id request and response headers were not previously documented.
  • Event triggers - Made the following updates to all operations:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead. The Zuora-Request-Id response header was not previously documented.
  • Notifications - Made the following updates to all operations except “Get callout notification histories” and “Get email notification histories”:

    • Added a new Zuora-Track-Id request header and a new Zuora-Track-Id response header.
    • Removed the Zuora-Request-Id request header, which means that you now cannot control the value of the Zuora-Request-Id response header. You should use the new Zuora-Track-Id request and response headers instead.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • Corrected the request samples in the “Edit attachments” operation. Previously, all the request samples included a Curl request.

  • Added the following missing operations:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • Changed the name of the “Notifications” section. Previously, this section was called “Notification”.

  • Escaped single quotes in the Curl and PHP request samples for the following operations:

    • Query
    • Create an event trigger
    • Update an event trigger
    • Update custom fields on revenue items by revenue event number
    • Update custom fields on revenue items by revenue schedule number
    • Create revenue schedule for credit memo item (manual distribution)
    • Create revenue schedule for debit memo item (manual distribution)
    • Create revenue schedule for Invoice Item Adjustment (manual distribution)
    • Create revenue schedule for Invoice Item (manual distribution)
    • Distribute revenue across accounting periods
    • Create revenue schedule on subscription charge
  • In the “Get callout options” operation, added the following response headers:

    • Authorization
    • Zuora-Entity-Ids
  • Corrected the name of the IntegrationId__NS field in the request body of the “Subscribe” operation. Previously, the name of the field was incorrectly documented as IntegrationId_NS.

  • Corrected the name of the IntegrationId__NS field in the response bodies of the following operations:

    • Get invoices
    • CRUD: Retrieve InvoiceItem

    Previously, the name of the field was incorrectly documented as IntegrationId_NS.

  • Corrected the name of the Class__NS, Department__NS, and Location__NS fields in the request bodies of the following operations:

    • CRUD: Create ProductRatePlan
    • CRUD: Retrieve ProductRatePlan

    Previously, the names of the fields were incorrectly documented as Class_NS, Department_NS, and Location_NS.

  • Corrected the name of the Class__NS, Department__NS, and Location__NS fields in the response bodies of the following operations:

    • Get product catalog
    • CRUD: Retrieve ProductRatePlan

    Previously, the names of the fields were incorrectly documented as Class_NS, Department_NS, and Location_NS.

Zuora Documentation

Re: API Changelog

2018-05-08

 

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 224, May 2018.

 

  • Invoices - Added the following new operations:
    • Write off invoice
    • Get invoice files
    • Get invoice items

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • In the description of the “Get breakdown of credit memo by order” operation, noted that you can only use this operation to retrieve breakdowns of credit memos whose source value is BillRun or API.

  • Changed the Curl code sample in the “Create an event trigger” operation to be consistent with the samples in other languages.

  • In the source YAML file, replaced some parts of the following reference objects by new reference objects:

    • POSTPublicNotificationDefinitionRequest
    • PUTPublicNotificationDefinitionRequest
    • GETPublicNotificationDefinitionResponse

    The new reference objects are used in the following fields:

    • callout > calloutParams
    • filterRule > parameters
    • filterRuleParams
  • Removed the following unused definitions from the source YAML file:

    • POSTPublicCalloutRequest
    • PUTPublicCalloutRequest
    • GETPublicCalloutResponse
    • POSTPublicFilterRuleRequest
    • PUTPublicFilterRuleRequest
    • GETPublicFilterRuleResponse
    • POSTPublicCalloutOptionsRequest