2023 Changelog

This page summarizes the changes that are made to the API Reference for Billing, Collect, and Central Platform in 2023.

For release notes for all Zuora products, see Latest releases.

January 19, 2023

Doc updates

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

  • Updated the default MIME type for all operations from application/json;charset=utf-8 to application/json .
  • In the request body of the "Create a payment method" operation, updated the description of the bankAccountName field to clarify requirements specific to the BlueSnap integration.
  • In the request body of the "Create an account" operation, updated the description of the paymentMethod > bankAccountName field to clarify requirements specific to the BlueSnap integration.
  • In the request body of the "Create an order" operation, updated the description of the newAccount > paymentMethod > bankAccountName field to clarify requirements specific to the BlueSnap integration.
  • Fixed the broken links in the description of the "Payment Gateway Reconciliation" section.
  • Updated the description of each of the following operations:
    • Upload a usage file
    • Update an account
    • List all products
    • List all product rate plans of a product
    • Refund a payment
    • Delete a payment method
    • Create a credit memo from a charge
    • Create a notification definition
    • Create an order
    • Preview an order
    • CRUD: Update a contact
    • CRUD: Update a payment method
    • List all invoices for an account
  • In the request body of the "CRUD: Create a product rate plan" operation, updated the description of the ActiveCurrencies field.
  • In the response body of the "List subscriptions by account key" operation, updated the description of the subscriptions > ratePlans > lastChangeType field.
  • In the response body of each of the following operations, updated the description of the ratePlans > lastChangeType field:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
  • In the description of the subscription-key path parameter of the "Update a subscription" operation, suggested retrieving the latest or history version of the subscription ID before updating a specific version of the subscription.
  • In the response body of the "Retrieve an order line item" operation, corrected the data type of the orderLineItem > productRatePlanChargeId field.
  • In the description of the "Cancel a payment schedule" operation, clarified that only pending payment schedule items will be canceled.
  • In the response body of each of the following operations:
    • Retrieve a payment schedule item
    • Update a payment schedule item
    • Cancel a payment schedule item
    • Skip a payment schedule item

    Updated the description of each of the following fields to state the requirement on the API version:

    • balance
    • psiPayments
  • In the response body of each of the following operations:
    • Create a payment schedule
    • List payment schedule by customer account
    • Create multiple payment schedules at once
    • Retrieve a payment schedule
    • Add payment schedule items to a custom payment schedule
    • Retry failed payment schedule items

    Updated the description of each of the following fields to state the requirement on the API version:

    • items > balance
    • items > psiPayments

January 13, 2023

API updates

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

The following API updates are available as of Zuora Release 2022.01.R2. For release notes for all Zuora products, see Latest releases.

API updates for the Flexible Billing feature

The following items are the API updates specific to the Flexible Billing feature.

  • Subscriptions - Made the following updates:
    • In the response body of the "List subscriptions by account key" operation, added the following nested field to the subscriptions field:
      • invoiceTemplateName
      • sequenceSetName
    • In the response body of each of the following operations, added the invoiceTemplateName and sequenceSetName fields:
      • Retrieve a subscription by key
      • Retrieve a subscription by key and version

API updates for the Billing Schedule feature

The following items are the API updates specific to the Early Adopter announcement of the Billing Schedule feature.

  • Orders - Made the following updates:
    • In the response body of each of the following operations, added the invoiceScheduleId nested field to the order field:
      • Retrieve an order
      • List order metrics for an evergreen subscription
    • In the response body of each of the following operations, added the invoiceScheduleId nested field to the orders field:
      • List orders
      • List orders of a subscription owner
      • List orders by subscription number
      • List orders of an invoice owner
      • List pending orders by subscription number
  • Subscriptions - Made the following updates:
    • In the response body of the "List subscriptions by account key" operation, added the invoiceScheduleId nested field to the subscriptions field:
    • In the response body of each of the following operations, added the invoiceScheduleId field:
      • Retrieve a subscription by key
      • Retrieve a subscription by key and version

API updates for the Payment Schedules feature

The following items are the API updates specific to the Payment Schedules feature.

  • Payment Schedules - Made the following updates:
    • In the request body of the “Update a payment schedule item” operation, added the following fields to support linking multiple payments to a payment schedule item:
      • linkPayments
      • unlinkPayments
    • In the response body of each of the following operations:
      • Retrieve a payment schedule item
      • Update a payment schedule item
      • Cancel a payment schedule item
      • Skip a payment schedule item

      Added the following fields to support linking multiple payments to a payment schedule item and payment schedule item balance:

      • balance
      • psiPayments
    • In the response body of each of the following operations:
      • Create a payment schedule
      • List payment schedule by customer account
      • Create multiple payment schedules at once
      • Retrieve a payment schedule
      • Add payment schedule items to a custom payment schedule
      • Retry failed payment schedule items

      Added the following fields to support linking multiple payments to a payment schedule item and payment schedule item balance:

      • items > balance
      • items > psiPayments

Other API updates

The following items are the other general API updates included in this release:

  • Accounts - Added an operation called "Delete an account".
  • Invoices - Made the following updates:
    • Added an operation called "Retrieve an invoice".
    • In the request body of the "Post invoices" operation, added the support for custom fields to the invoices field.
  • Custom Object Jobs - Added an operation called "Cancel a custom object bulk job".
  • Communication Profiles - In the response body of the "CRUD: Retrieve a communication profile" operation, added the following fields:
    • IsDefault
    • Muted

Doc updates

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

  • Updated the description of each of the following actions:
    • Create
    • Update
  • In the request body of each of the following operations, removed the unsupported SubmissionDateTime field:
    • CRUD: Create a usage record
    • CRUD: Retrive a usage record
    • CRUD: Update a usage record
  • In the description of the “Update a payment schedule item” operation, added notes on linking and unlinking multiple payments to a payment schedule item.
  • In the response body of the "List credit memo items" operations, added the missing OrderLineItem enum value to each of the following fields:
    • items > sourceItemType
    • items > sourceItemId
  • In the response body of the "Retrive a credit memo item" operation, added the missing OrderLineItem enum value to each of the following fields:
    • sourceItemType
    • sourceItemId
  • In the response body of the "List credit memos” operation, added the missing Order , CreditMemo , and Consolidation enum values to the creditmemos > sourceType field.
  • In the response body of each of the following operation, added the missing Order , CreditMemo , and Consolidation enum values to the memos > sourceType field:
    • Create credit memos
    • Update credit memos
  • In the response body of each of the following operations, added the missing Order , CreditMemo , and Consolidation enum values to the sourceType field:
    • Retrive a credit memo
    • Create a credit memo from a charge
    • Create a credit memo from an invoice
    • Update a credit memo
    • Apply a credit memo
    • Cancel a credit memo
    • Post a credit memo
    • Unapply a credit memo
    • Unpost a credit memo

January 06, 2023

API updates

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

The following API updates are available as of Zuora Release 2023.01.R1.

Doc updates

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

  • In the request body of each of the following operations, updated the description of the gatewayOptions field by adding a link to the relevant article in the Knowledge Center:
    • Create a payment method
    • Update a payment method
    • Verify a payment method
    • Create authorization
    • Cancel authorization
    • Create a payment
    • Refund a payment
  • In the request body of the “Create a standalone invoice” operation, updated the description of the invoiceItems > unitPrice field to state this field is required for passing Level 3 card data to the gateway.
  • In the request body of the “Create standalone invoices” operation, updated the description of the invoices > invoiceItems > unitPrice field to state this field is required for passing Level 3 card data to the gateway.
  • In each of the Orders operations and Order Line Items operations, updated the general availability note about the Orders feature.
  • In the request body of the “Create a standalone invoice” operation, added a note to the description of each of the following fields about the permission control information:
    • invoiceItems > taxItems
    • invoiceItems > discountItems > taxItems
  • In the request body of the “Create standalone invoices” operation, added a note to the description of each of the following fields about the permission control information:
    • invoices > invoiceItems > taxItems
    • invoices > invoiceItems > discountItems > taxItems