Happy Business Starts Here

Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-08

  •  
  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 280, July 2020.

  •  

    • Product Rate Plans - In the response body of the “Get product rate plans” operation, made the following updates:

      • Added the following values to the productRatePlans > productRatePlanCharges > model field:
        • MultiAttributePricing
        • PreratedPerUnit
        • PreratedPricing
        • HighWatermarkVolumePricing
        • HighWatermarkTieredPricing
      • Changed the behavior of the productRatePlans > productRatePlanCharges > pricingSummary field.
    • Subscriptions - Made the following updates

      • In the request body of the following operations, added the chargeModelConfiguration nested field to the subscribeToRatePlans > chargeOverrides field:
        • Preview subscription
        • Create subscription
      • In the request body of the "Update subscription" operations, added the chargeModelConfiguration nested field to the following fields:
        • add > chargeOverrides
        • update > chargeUpdateDetails
      • In response body of the "Get subscriptions by account" operation, added the chargeModelConfiguration nested field to the subscriptions > ratePlans > ratePlanCharges field.
      • In response body of the following operations, added the chargeModelConfiguration nested field to the ratePlans > ratePlanCharges field:
        • Get subscriptions by key
        • Get subscriptions by key and version
    • Orders - Made the following updates:

      • In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, added the chargeModelData field and its nested fields to the following fields:

        • subscriptions > orderActions > addProduct > chargeOverrides > pricing
        • subscriptions > orderActions > updateProduct > chargeUpdates > pricing
        • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing
      • In the the response body of the following operations, added the chargeModelData field and its nested fields to the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > field:

        • Get an order
        • Get order metrics for evergreen subscription
      • In the response body of the following operations, added the chargeModelData field and its nested fields to the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing field:

        • Get all orders
        • Get orders by subscription owner
        • Get orders by subscription number
        • Get orders by invoice owner
      • In the request body of the following operations, changed the behavior of the subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > triggerEvent field:

        • Create order
        • Create order asynchronously

        Currently, if the triggerEvent field is not specified, the value of this field will be defaulted to the trigger event value in the product catalog.

        Previously, if this field was not specified, the value of the field would be defaulted to the trigger event value in the base subscription on which the order was created.

        This behavior change was introduced in Zuora Billing Release 279.

    • Added the rejectUnknownFields query parameter to the following operations:

      • All Actions
      • All CRUD operations that use the POST method
      • All CRUD operations that use the PUT method
    • Accounts - In the request body of the "CRUD: Update account" operation, changed the behavior of the AccountNumber field. See the description of the AccountNumber field to find out details about the latest behavior.

  •  
  • Doc Updates

     

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

  •  

    • In the request body of the following operations, corrected the description of the mitProfileAgreedOn field:

      • Create payment method
      • Create credit card payment method
      • Create account
      • Create order
      • Create order asynchronously
      • Preview order
      • Preview order asynchronously
    • In the request body of the following operations, corrected the description of the items > skuName field:

      • Create credit memo from invoice
      • Create debit memo from invoice
      • Write off invoice
Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-16

  •  
  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 281, July 2020.

  •  

    • Orders - Made the following updates:

      • Added the returnId query parameter to the "Create order asynchronously" operation.
      • In the response body of the "Get job status and response" operation, added the following nested fields to the result field:
        • accountId
        • creditMemoIds
        • invoiceId
        • orderId
        • paymentId
        • subscriptionIds
    • Invoices - Changed the behavior of the “Write off invoice” operation. If you set the Create credit memos mirroring invoice items billing rule to Yes, you can now write off an invoice even if all its items have zero balance.

    Doc Updates

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

    • In the request body of the "Create payment method" operation, added the missing accountHolderInfo field and its nested fields.

    • In the request body of the "Create account" operation, added the missing accountHolderInfo nested field to the paymentMethod field.

    • In the request body of the following operations, added the missing accountHolderInfo nested field to the newAccount > paymentMethod field:

      • Create order
      • Create order asynchronously
    • In the request body of the following operations, added the missing accountHolderInfo nested field to the subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > paymentMethod field:

      • Preview order
      • Preview order asynchronously
    • Corrected the examples in the description of each of the following operations:

      • Get credit memos
      • Get debit memos
Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-24

  •  
  • Doc Updates

     

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

  •  

    • Removed the mistakenly documented "CRUD: Delete payment method snapshot" operation.

    • Added the 403 response schema and sample to the "Get data query job" operation.

    • Added the access control explanations to the descriptions of the following operations:

      • Get data query jobs
      • Get data query job
    • Updated the description in the "Error Handling" section.

Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-07-31

  •  
  • Doc Updates

     

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

  •  
    • Added the reference link to the newly published API Guides, which cover common REST API use cases.

    • Updated the description of the “Data Queries” section.

Highlighted
Zuora Documentation

Re: API Changelog

  • This changelog outlines the latest REST API updates and documentation updates in the API Reference. We would love to hear your feedback on how we can improve it. If you have any comments on the API Changelog, please send an e-mail to docs@zuora.com. Thank you!

  •  

    2020-08-05

  •  
  • API Updates

     

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

  •  

    The following API updates are available as of Zuora Billing Release 282, August 2020.

  •  

    • Payment Methods - Added the gatewayOptions field to the request body of each of the following operations:

      • Create credit card payment method
      • Update credit card payment method
    • Actions - Made the following updates:

      • In the request body of the "Amend" action, updated the character limit of the request > AmendOptions> ExternalPaymentOptions > ReferenceId field from 60 to 100.
      • In the request body of the "Subscribe" action, updated the character limit of the subscribes > SubscribeOptions> ExternalPaymentOptions > ReferenceId field from 60 to 100.
    • Payment Gateway Reconciliation - In the request body of each of the "Reject payment" and "Reverse payment" operations, updated the character limit of the following fields from 60 to 100:

      • referenceId
      • secondReferenceId
    • Payments - Made the following updates:

      • In the request body of each of the following operations, updated the character limit of the referenceId field from 60 to 100:
        • Create payment
        • Update Payment
      • In the request body of each of the following operations, updated the character limit of the ReferenceId field from 60 to 100:
        • CRUD: Create payment
        • CRUD: Update payment
      • In the request body of the "Refund payment" operation, updated the character limit of the following fields from 60 to 100:
        • referenceId
        • secondRefundReferenceId
    • Refunds - In the request body of the "Update refund" operation, updated the character limit of the referenceId field from 60 to 100.

    • Credit Memos - In the request body of the "Refund credit memo" operation, updated the character limit of the following fields from 60 to 100:

      • referenceId
      • secondRefundReferenceId
    • Revenue Schedules - In the request body of each of the following operations, updated the character limit of the referenceId field from 60 to 100:

      • Update revenue schedule basic information
      • Create revenue schedule on subscription charge
    • Credit Balance Adjustments - In the request body of the "CRUD: Create CreditBalanceAdjustment" operation, updated the character limit of the ReferenceId field from 60 to 100.

    • Invoice Adjustments - In the request body of the "CRUD: Create InvoiceAdjustment" operation, updated the character limit of the ReferenceId field from 60 to 100.

    • Taxation Items - Made the following updates:

      • Changed the behavior of the "Update taxation item" operation. You can now update the custom fields of the Taxation Item object for all invoices, credit memos, and debit memos regardless of their status.

        Previously, you could only update the custom fields of the Taxation Item object for invoices, credit memos, and debit memos in Draft status.

      • Changed the behavior of the "CRUD: Update TaxationItem" operation. You can now update the custom fields of the Taxation Item object for all invoices regardless of their status.

        Previously, you could only update the custom fields of the Taxation Item object for invoices in Draft status.

     

  • Doc Updates

     

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

  •  
    • In the description of the “Perform mass action” operation, added a reference link to the Mass Payment Upload article.
    • In the "Query custom object records" operation, added a note to the description of the q query parameter.
    • In the description of the "Create an event trigger" operation, made the following updates:
      • Restructured the description.
      • Added the list of tenant level base objects.
      • Noted the availabilities of tenant level event triggers and system notifications.
Highlighted
Zuora Documentation

Re: API Changelog

  • 2020-08-13

     

  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 283, August 2020.

  •  

    • Credit Memos - Made the following updates:

      • In the request body of the "Update credit memo" operation, added support for custom fields to the items > taxItems field.
      • In the response body of the "Get credit memo items" operation, added support for custom fields to the the following fields:
        • items > creditTaxItems
        • items > taxationItems > data
      • In the response body of the "Get credit memo item" operation, added support for custom fields to the following fields:
        • creditTaxItems
        • taxationItems > data
      • In the response body of the "Get taxation items of credit memo item" operation, added support for custom fields to the data field.

      You can now update and retrieve the custom fields of the Credit Taxation Item object for all credit memos regardless of their status.

    • Debit Memos - Made the following updates:

      • In the request body of the "Update debit memo" operation, added support for custom fields to the items > taxItems field.
      • In the response body of the "Get debit memo items" operation, added support for custom fields to the following fields:
        • items > taxItems
        • items > taxationItems > data
      • In the response body of the "Get debit memo item" operation, added support for custom fields to the following fields:
        • taxItems
        • taxationItems > data
      • In the response body of the "Get taxation items of debit memo item" operation, added support for custom fields to the data field.

      You can now update and retrieve the custom fields of the Debit Taxation Item object for all debit memos regardless of their status.

    • Orders - Updated the API limitation for the following API operations:

      • Create order
      • Preview order
      • Create order asynchronously
      • Preview order asynchronously

     

  • Doc Updates

     

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

  •  

    • In the response body of the "Get account summary" operation, corrected the description of the basicInfo > defaultPaymentMethod > id field.

    • In the request body of the "Create account" operation, corrected the description of the hpmCreditCardPaymentMethodId field.

    • In the request body of each of the "Create order" and "Create order asynchronously" operations, updated the description of the following fields for consistency:

      • newAccount > hpmCreditCardPaymentMethodId
      • subscriptions > orderActions > createSubscription >newSubscriptionOwnerAccount > hpmCreditCardPaymentMethodId
    • In the request body of each of the following operations, updated the description of the subscriptions > orderActions > createSubscription >newSubscriptionOwnerAccount > hpmCreditCardPaymentMethodId field for consistency:

      • Preview order
      • Preview order asynchronously
    • In the request body of each of the following operations, removed the incorrect description of the default value for the initialTerm field.

      • Preview subscription
      • Create subscription
    • In the request body of the "Put subscription" operation, removed the incorrect description of the default value for the currentTerm field.

    • In the request body of the "CRUD: Update Subscription" operation, removed the incorrect description of the default value for the InitialTerm field.

Highlighted
Zuora Documentation

Re: API Changelog

  • 2020-08-21

     

  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 284, August 2020.

  •  

    • Rate Plan Charges - In the "CRUD: Update rate plan charge" operation, enhanced the TriggerEvent request field to support directly updating the trigger condition of a rate plan charge for Order customers. If you are Zuora's Subscribe and Amend customers, you already have the access to this feature.

    • Subscriptions - Made the following updates:

      • In the response body of each of the following operations, added the subscriptionEndDate field.

        • Get subscriptions by key
        • Get subscriptions by key and version
      • In the response body of the "Get subscriptions by account" operation, added the subscriptions > subscriptionEndDate field.

     

  • Doc Updates

     

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

  •  

    • In the request body of the "CRUD: Create payment method" operation, added the missing DirectEntryAU enum value to the BankTransferType field.

    • In the request body of the "Subscribe" action, added the missing NativeExpressCheckout enum value to the subscribes > PaymentMethod > PaypalType field.

Highlighted
Zuora Documentation

Re: API Changelog

  • 2020-08-28

     

  • API Updates

     

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

     

  • The following API updates are available as of August 28, 2020.

  •  

    • Charge Metrics - Added a resource called "Charge Metrics", with the following operations:
      • Get charge metrics
      • Get discount allocation details

     

  • Doc Updates

     

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

  •  

    • In the "Error Handling" section, updated the description to reflect the error handling behavior for GET and DELETE requests.
Highlighted
Zuora Documentation

Re: API Changelog

  • 2020-08-31

     

  • API Updates

     

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

     

  • Orders is now generally available as of Zuora Billing Release 284, August 31, 2020. The following API updates are available for the release.

  •  

    Note: The API updates described below are currently available in the Sandbox environment only. They will become available in the Production environment on September 10.

  •  

    • Ramps - Added a resource called "Ramps", with the following operations:

      • Get ramp by ramp number
      • Get ramp metrics by ramp number
      • Get ramp by subscription key
      • Get ramp metrics by subscription key
      • Get ramp metrics by order number
    • Orders - Made the following updates:

      • In the request body of each of the following operations, added the ramp field and its nested fields to the subscriptions field.

        • Create order
        • Create order asynchronously
        • Preview order
        • Preview order asynchronously
      • In the request body of each of the following operations, added the RampMetrics and RampDeltaMetrics enum values to the previewOptions > previewTypes field.

        • Preview order
        • Preview order asynchronously
      • In the response body of the "Create order" operation, added the ramps field and its nested fields.

      • In the response body of the "Preview order" operations, added the rampMetrics and its nested fields to the previewResult field.

      • In the response body of each of the following operations, added the ramp field and its nested fields to the order > subscriptions field:

        • Get an order
        • Get order metrics for evergreen subscription
      • In the response body of each of the following operations, added the ramp field and its nested fields to the orders > subscriptions field:

        • Get all orders
        • Get orders by subscription owner
        • Get orders by subscription number
        • Get orders by invoice owner
      • In the request body of the "Preview order" operation, made the following updates:

        • Added the NumberOfPeriods enum value to the previewOptions > previewThruType field.
        • Added the previewNumberOfPeriods field to the previewOptions nested field.
      • In the response body of each of the following operations:

        • Get an order
        • Get all orders
        • Get orders for subscription owner
        • Get orders for subscription number
        • Get orders for invoice owner

        deprecated the following fields for any new customers who onboard on Orders or Orders Harmonization. Existing Orders customers who have these fields will continue to be supported.

        • order(s) > subscriptions > orderActions > orderItems
        • order(s) > subscriptions > orderActions > orderMetrics > elp
        • order(s) > subscriptions > orderActions > orderMetrics > quantity > orderItemId
        • order(s) > subscriptions > orderActions > orderMetrics > quantity > generatedReason
        • order(s) > subscriptions > orderActions > orderMetrics > mrr > orderItemId
        • order(s) > subscriptions > orderActions > orderMetrics > mrr > generatedReason
        • order(s) > subscriptions > orderActions > orderMetrics > tcb > orderItemId
        • order(s) > subscriptions > orderActions > orderMetrics > tcb > generatedReason
        • order(s) > subscriptions > orderActions > orderMetrics > tcv > orderItemId
        • order(s) > subscriptions > orderActions > orderMetrics > tcv > generatedReason
      • In the response body of the "Preview order" operation, deprecated the following fields for any new customers who onboard on Orders or Orders Harmonization. Existing Orders customers who have these fields will continue to be supported.

        • previewResult > orderMetrics > orderActions > orderItems
        • previewResult > orderMetrics > orderActions > orderMetrics > elp
        • previewResult > orderMetrics > orderActions > orderMetrics > quantity > orderItemId
        • previewResult > orderMetrics > orderActions > orderMetrics > quantity > generatedReason
        • previewResult > orderMetrics > orderActions > orderMetrics > mrr > orderItemId
        • previewResult > orderMetrics > orderActions > orderMetrics > mrr > generatedReason
        • previewResult > orderMetrics > orderActions > orderMetrics > tcb > orderItemId
        • previewResult > orderMetrics > orderActions > orderMetrics > tcb > generatedReason
        • previewResult > orderMetrics > orderActions > orderMetrics > tcv > orderItemId
        • previewResult > orderMetrics > orderActions > orderMetrics > tcv > generatedReason

     

  • Doc Updates

     

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

  •  

    • In all the Orders operations, updated the notes to inform that Orders is now generally available.
Highlighted
Zuora Documentation

Re: API Changelog

  • 2020-09-08

     

  • API Updates

     

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

     

  • The following API updates are available as of Zuora Billing Release 285, September 2020.

  •  

    • Custom Object Definitions - Made the following updates:
      • In the request body and response body of the "Update custom object definition" operation, added the filterable nested field to the action > field field.
      • In the description of the "Create custom object definition" operation, explained the enhancement of this operation.

     

  • Doc Updates

     

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

  •  

    • In the request body of the "CRUD: Create payment method" operation, updated the description of the SkipValidation field.

    • In the Zuora Object Model section, updated the diagram to encompass the Orders feature and Invoice Settlement feature.