API Changelog

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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-12-04

  Doc Updates

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

• • In the description of the "List all settings" operation, added references to the newly added Settings API tutorials in the Knowledge Center.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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-12-10

• API Updates

•  

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

• The following API updates are available as of Zuora Billing Release 289, December 2020.

• • Orders - Made the following updates to remove the 10-year limitation on the duration of subscription terms. Previously, the duration of the initial term or renewal term of a subscription could not be greater than 10 years.

    • In the request body of each of the following operations:

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

      Removed the 10-year limitation in each of the following fields:

      • subscriptions > orderActions > createSubscription > terms > initialTerm > period
      • subscriptions > orderActions > createSubscription > terms > renewalTerms > period
      • subscriptions > orderActions > termsAndConditions > lastTerm > period
      • subscriptions > orderActions > termsAndConditions > renewalTerms > period

    • In the response body of each of the following operations:

      • Get an order
      • Get order metrics for evergreen subscription

      Removed the 10-year limitation in each of the following fields:

      • order > subscriptions > orderActions > createSubscription > terms > initialTerm > period
      • order > subscriptions > orderActions > createSubscription > terms > renewalTerms > period
      • order > subscriptions > orderActions > termsAndConditions > initialTerm > period
      • order > subscriptions > orderActions > termsAndConditions > renewalTerms > period

    • In the response body of each of the following operations:

      • Get all orders
      • Get orders by subscription owner
      • Get orders by subscription number
      • Get orders by invoice owner

      Removed the 10-year limitation in each of the following fields:

      • orders > subscriptions > orderActions > createSubscription > terms > initialTerm > period
      • orders > subscriptions > orderActions > createSubscription > terms > renewalTerms > period
      • orders > subscriptions > orderActions > termsAndConditions > initialTerm > period
      • orders > subscriptions > orderActions > termsAndConditions > renewalTerms > period

  • Debit Memos - Made the following updates:

    • Added an operation called "Collect existing posted debit memo".
    • In the request body of the "Create debit memo from charge" operation, added the autoPost field.

  • Credit Memos - Made the following updates:

    • In the request body of the "Create credit memo from charge" operation, added the autoPost field.
    • In the request body of the "Refund credit memo" operation, added the following fields:
      • SoftDescriptor
      • SoftDescriptorPhone

  • Invoices - In the request body of each of the following operations, added the autoPost field:

    • Create credit memo from invoice
    • Create debit memo from invoice

  • Payments - In the request body of each of the "Create payment" and "Refund payment" operations, added the following fields:

    • SoftDescriptor
    • SoftDescriptorPhone

  • Attachments - Made the following updates:

    • Changed the behaviors of the following operations. You can now use these operations to manage attachments for credit memos and debit memos:

      • Add attachments
      • View attachments list
      • View attachments
      • Edit attachments
      • Delete attachments

    • In the "Add attachments" operation, added the following enum values to the associatedObjectType query parameter and changed the behavior of the associatedObjectKey query parameter accordingly:

      • CreditMemo
      • DebitMemo

    • In the "View attachments" operation, added the following enum values to the object-type query parameter and changed the behavior of the object-key query parameter accordingly:

      • creditmemo
      • debitmemo

   

• Doc Updates

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

• • Corrected the description of the "Credit Card" section in the "Create payment method" operation.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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-12-18

• 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 289, December 2020.

   
  • Invoices - Changed the behavior of the following operations. You can now write off or reverse an invoice if it contains at most 2,000 items. The limit was 750 previously.
    • Reverse invoice
    • Write off invoice

   

• Doc Updates

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

• • In the response body of the following operations, corrected the enum value completed to complete for the taxStatus field:

    • Create credit memo from charge
    • Create credit memo from invoice
    • Get credit memo
    • Update credit memo
    • Apply credit memo
    • Unapply credit memo
    • Cancel credit memo
    • Post credit memo
    • Unpost credit memo
    • Create debit memo from charge
    • Create debit memo from invoice
    • Get debit memo
    • Update debit memo
    • Cancel debit memo
    • Post debit memo
    • Unpost debit memo

  • In the response body of the "Get credit memos" operation, corrected the enum value completed to complete for the creditmemos > taxStatus field.

  • In the response body of the "Get debit memos" operation, corrected the enum value completed to complete for the debitmemos > taxStatus field. 

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-01-12

   

• 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 290, January 2021.

•  

  • Actions - Made the following updates:

    • In the request body of the "Amend" action, added the following nested fields to the AmendOptions field:
      • ApplicationOrder
      • ApplyCredit
    • In the response body of the "Amend" action, added the following fields:
      • CreditMemoDatas field and its nested fields
      • CreditMemoId
    • In the request body of the "Subscribe" action, added the following nested fields to the subscribes > SubscribeOptions field:
      • ApplicationOrder
      • ApplyCredit
    • In the response body of the "Subscribe" action, added the following fields:
      • CreditMemoData field and its nested fields
      • CreditMemoId
      • CreditMemoNumber
      • CreditMemoResult field and its nested fields

  • Payments - In the response body of the "CRUD: Get payment" operations, added the following fields:

    • AppliedAmount
    • UnappliedAmount

  • Invoices - In the response body of the "Write off invoice" operation, added the support for NetSuite custom fields.

  • Exports - Explained the newly enforced Data Source Export limits in the descritpion of the “CRUD: Create Export” operation.

  • Notifications - Added the following operations:

    • Delete notification histories for an account
    • Get a notification history deletion task

  • Orders - Made the following updates to add the applyDiscountTo and discountLevel fields to the Update product order action in all the Orders APIs.

    • In the request body of each of the following operations:

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

      Added the following fields:

      • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo
      • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > discountLevel

    • In the response body of each of the following operations:

      • Get an order
      • Get order metrics for evergreen subscription

      Added the following fields:

      • order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo
      • order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo

    • In the response body of each of the following operations:

      • Get all orders
      • Get orders by subscription owner
      • Get orders by subscription number
      • Get orders by invoice owner

      Added the following fields:

      • orders > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo
      • orders > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > discount > applyDiscountTo

  • Subscriptions - Made the following updates for a new field on the Subscription object.

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

      • Get subscriptions by key and version
      • Get subscriptions by key

    • In the response body of the "Get subscriptions by account" operation, added the revision field in the subscriptions nested field.

    • In the "CRUD: Retrieve Subscription" operation:

      • Added the X-Zuora-WSDL-Version request header parameter.
      • Added the Revision field in the response body.
•  

• Doc Updates

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

• • In the "Payment Methods" section, added the following missing operations:

    • Update payment method
    • Get payment method

  • Removed the incorrect Id path parameter from the request sample in the "CRUD: Update Subscription" operation.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-01-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 291, January 2021.

• • Payments - Made the following updates:

    • Changed the behavior of each of the following operations. When the Invoice Settlement feature is enabled, you can now use these operations to create or update payments.
      • CRUD: Create payment
      • CRUD: Update payment
    • In the request body of the "CRUD: Create payment" operation, changed the behavior of the following fields:
      • AppliedCreditBalanceAmount
      • Status
    • In the request body of the "CRUD: Update payment" operation, changed the behavior of the Status field.
    • In the response body of the "CRUD: Get payment" operation, changed the behavior of the following fields:
      • AppliedCreditBalanceAmount
      • Status

  • Refunds - Made the following updates:

    • Changed the behavior of each of the following operations. When the Invoice Settlement feature is enabled, you can now use these operation to refund payments.
      • CRUD: Create refund
      • CRUD: Update refund
    • In the request body of the "CRUD: Create refund" operation, changed the behavior of the SourceType field.

   

• Doc Updates

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

• • In the "Subscribe" action, updated the description for the action and the description of the subscribes > SubscriptionData > RatePlanData > RatePlanChargeData > RatePlanCharge > TriggerEvent field in the request body to indicate when previewing invoices with this action, the corresponding Contract Effective, Service Activation, or Customer Acceptance date is required if the subscription contains a charge with its trigger event being set as ContractEffectiveDate, ServiceActivationDate, or CustomerAcceptanceDate.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-01-29

   

• API Updates

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

  • As of Zuora Billing Release 288, November 2020, the legacy endpoint /apps/api/file/{file-id} can no longer be used to retrieve files. Instead, you should use Get files to retrieve files.

    Note: Responses from "Get files" contain character encoding information in the Content-Type header. For example, Content-Type: application/pdf;charset=UTF-8. Responses from /apps/api/file/{file-id} did not contain character encoding information in the Content-Type header. For example, Content-Type: application/pdf.

   

• Doc Updates

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

• • In the description of the "Get files" operation, added information about the response content type.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-02-09

   

• 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 292, February 2021.

• • Data Queries - Made the following updates:

    • Added the sourceData field to the request schema of the "Submit data query" operation.

  • Added the following RateLimit response headers to all the responses of each and every operation:

    • RateLimit-Limit
    • RateLimit-Remaining
    • RateLimit-Reset

  • Payments - Made the following updates:

    • In the request body of the "Create payment" operation, added the gatewayOptions field and its nested fields.
    • In the response schema of the "Refund payment" operation, changed the error category code 60 to 50 and optimized the corresponding error message for the errors occurring while issuing external refunds with the default reason code.

  • Credit Memos - In the response schema of the "Refund credit memo" operation, changed the error category code 60 to 50 and optimized the corresponding error message for the errors occurring while issuing external refunds with the default reason code.

   

• Doc Updates

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

• • In the description of the “Update account” operation, clarified the update details of the Bill To and Sold To contacts in the same customer account.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-02-19

   

• API Updates

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

• The following API updates are available as of Zuora Billing Release 293, February 2021.

• • Credit Memos - Made the following updates:

    • In the description of the "Apply credit memo" operation, changed the limit on applying credit memos, and added the limit to the following fields in the request body:
      • invoices
      • invoices > items
      • debitMemos
      • debitMemos > items
    • In the description of the "Refund credit memo" operation, added a limit on refunding credit memos.
    • In the description of the "Unapply credit memo" operation, changed the limit on unapplying credit memos, and added the limit to the following fields in the request body:
      • invoices
      • invoices > items
      • debitMemos
      • debitMemos > items

  • Payments - Made the following updates:

    • In the request body of the "Create payment" operation, changed the limit on creating payments, and added the limit to the following fields in the request body:
      • invoices
      • invoices > items
      • debitMemos
      • debitMemos > items
    • In the description of the "Apply payment" operation, changed the limit on applying payments, and added the limit to the following fields in the request body:
      • invoices
      • invoices > items
      • debitMemos
      • debitMemos > items
    • In the description of the "Unapply payment" operation, added the limit on unapplying payments, and added the limit to the following fields in the request body:
      • invoices
      • invoices > items
      • debitMemos
      • debitMemos > items

  • Actions - Made the following updates:

    • In the request body of the "Subscribe" action, enhanced the subscribes > SubscribeOptions > ProcessPayments field for payment processing retries.
    • In the request body of the "Amend" action, enhanced the requests > AmendOptions > ProcessPayments field for payment processing retries.

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-02-25

   

• 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 294, February 2021.

• • Billing Preview Run - In the description of the "Create billing preview run" operation, changed the maximum number of concurrent billing preview runs to 20.

   

• Doc Updates

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

• • In the request body of the "Submit data query" operation, added a note to the description of the readDeleted field.
  •  

[Jing]

• This changelog outlines the latest REST API updates and documentation updates in the API Reference: Billing. The API changes are compliant with Zuora API Policy. 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!

• 2021-03-04

   

• API Updates

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

• The following API updates are available as of Zuora Billing Release 295, March 2021.

• • Payment Runs - Made the following updates to support the feature for creating custom payment runs.
    • In the request body of the "Create payment run" operation, added the data field. This field is only available if the feature for creating custom payment runs is enabled.
    • In the description of the "Create payment run" operation, added the behavior description for creating custom payment runs.
    • In the response body of the "Get payment run summary" operation, added the following fields:
      • numberOfInputData
      • numberOfProcessedInputData
      • numberOfErrorInputData
    • Added an operation called "Get payment run data" to retrieve payment run data and the processing result with details.
  •