v1 API changelog

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

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

October 25, 2024

API updates

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

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

• Omnichannel Subscriptions - Added the "Omnichannel Subscriptions" section that contains the following operations:
  • Create an omnichannel subscription
  • Retrieve an omnichannel subscription
  • Delete an omnichannel subscription
• Payment Schedules - Made the following updates:
  • Added the following operations:
    • Delete a payment schedule item
    • Delete a payment schedule
  • In the "Create a payment schedule" operation, made the following updates:
    • Updated the description of the operation to add the multi-currency characeteristics.
    • In the request body, updated the description of each of the currency and items > currency fields for multi-currency characeteristics.
  • In the "Update a payment schedule" and "Update a payment schedule item" operation, made the following updates:
    • Updated the description of each of the operations to add the multi-currency characeteristics.
    • In the request body of each of the operations, updated the description of the currency for multi-currency characeteristics.
  • In the "Add payment schedule items to a custom payment schedule" operation, made the following updates:
    • Updated the description of the operation to add the multi-currency characeteristics.
    • In the request body, updated the description of the items > currency field for multi-currency characeteristics.
• Custom Object Definitions - Made the following updates:
  • In the request body of the "Create custom object definitions" operation, added the following fields:
    • definitions > property name* > masked
    • definitions > property name* > properties > property name* > maskedFieldLength
  • In the 200 response body of each of the following operations:
    • Create custom object definitions
    • List custom object definitions

    Added the following fields:

    • definitions > property name* > schema > masked
    • definitions > property name* > schema > properties > property name* > maskedFieldLength
  • In the request body and 200 response body of the "Update a custom object definition" operation, added the following fields:
    • actions > field > masked
    • actions > field > definition > maskedFieldLength
  • In the 200 response body of the "Retrieve a custom object definition" operation, added the following fields:
    • schema > masked
    • schema > properties > property name* > maskedFieldLength
• Settings - Added the stackedDiscountClassApplyRule parameter to the BillingRules setting.

  See 200 response sample in JSON format.

Doc updates

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

• Updated the description of each of the following sections for better clarity:
  • Configuration Templates
  • Metadata
• In the 200 response body of the "Settle a payment" operation, added the following missing fields:
  • accountNumber
  • paymentGatewayNumber
• In the 200 response body of the "Create a summary statement run" operation, added the following missing fields:
  • statementRunNumber
  • updatedById
  • updatedDate

October 18, 2024

API updates

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

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

• Invoices - Made the following updates:
  • In the request body of the "Reverse an invoice" operation, added the following fields:
    • comment
    • reasonCode
  • In the request body of each of the "Update an invoice" and "Update invoices" operations, added the following fields:
    • invoices > invoiceItems > bookingReference
    • invoices > invoiceItems > delete
    • invoices > invoiceItems > productRatePlanChargeId
  • In the request body of each of the "Update an invoice" and "Update invoices" operations, updated the description of the invoices > invoiceItems > id field for better clarity.
• Credit Memos - Made the following updates:
  • In the request body of the "Reverse a credit memo" operation, added the following fields:
    • comment
    • reasonCode
  • In the request body of each of the "Update a credit memo" and "Update credit memos" operations, added the following fields:
    • memos > items > delete
    • memos > items > productRatePlanChargeId
  • In the request body of each of the "Update a credit memo" and "Update credit memos" operations, changed the memos > items > id field from required to optional and updated the field description for better clarity.
• Debit Memos - Made the following updates:
  • In the request body of each of the "Update a debit memo" and "Update debit memos" operations, added the following fields:
    • memos > items > delete
    • memos > items > productRatePlanChargeId
  • In the request body of each of the "Update a debit memo" and "Update debit memos" operations, changed the memos > items > id field from required to optional and updated the field description for better clarity.
  • In the request body of the "Create a debit memo from an invoice" operation, added the following fields:
    • billToContactId
    • soldToContactId
    • soldToSameAsBillTo
  • In the 200 response body of the "Create a debit memo from an invoice" operation, added the following fields:
    • soldToContactId
    • soldToContactSnapshotId
• Summary Statements - Added a "Summary Statements" section that contains the following operation:
  • Create a summary statement run
• Object Queries - Added the following operations:
  • List summary statement runs
  • Retrieve a summary statement run
  • List summary statements
  • Retrieve a summary statement
• Notifications - Made the following updates:
  • In the request body of each of the following operations:
    • Create a notification definition
    • Update a notification definition

    Made the following updates:

    • Added the following fields:
      • calloutTemplateIds
      • communicationProfileIds
    • Updated the description of each of the following fields:
      • callout
      • communicationProfileId
  • In the 200 response body of each of the following operations:
    • Create a notification definition
    • Retrieve a notification definition
    • Update a notification definition

    Made the following updates:

    • Added the following fields:
      • calloutTemplateIds
      • communicationProfileIds
    • Updated the description of the communicationProfileId field.
  • In the 200 response body of the "List notification definitions" operation, made the following updates:
    • Added the following fields:
      • data > calloutTemplateIds
      • data > communicationProfileIds
    • Updated the description of the data > communicationProfileId field.

Doc updates

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

• Updated the description of the "List all settings" operation to add references to the Summary Statement operations.
• Updated the description of each of the "Execute an invoice schedule" and "Pause an invoice schedule" operations for better clarity.
• In the request body of each of the following operations, updated the description of the charge-detail query parameter for better clarity:
  • List subscriptions by account key
  • Retrieve a subscription by key
  • ​​Retrieve a subscription by key and version
• Corrected the endpoint from /scim/v2/Group to /scim/v2/Groups for the following operations:
  • List groups
  • Create a group
• Corrected the endpoint from /scim/v2/Group/bulk to /scim/v2/Groups/bulk for the following operations:
  • Bulk create groups
  • Bulk update groups
• Added the missing request schemas for each of the following OneID operations:
  • Create a user
  • Update a user
  • Partially update a user
  • Create a group
  • Bulk delete groups
  • Update a group
  • Partially update a group
• Added the missing request example for each of the following OneID operations:
  • Bulk create users
  • Bulk create groups
  • Bulk update groups
  • Update a group
• Added the missing 200 response example for each of the following OneID operations:
  • List all schemas of resources
  • Create a user
  • Bulk create users
  • Update a user
  • Bulk create groups
  • Bulk delete groups
  • Retrieve a group
  • Delete a list of users
• Corrected the 200 response schema for each of the following OneID operations:
  • Create a user
  • List groups

The following changes are applicable to the Older API Reference:

• Made the following updates to align with the system behavior for orphan payment methods:
  • Updated the description of each of the following operations:
    • Create a credit card payment method
    • CRUD: Create a payment method
  • In the request body of the "Create a credit card payment method" operation, updated the description of the accountKey field.
  • In the request body of the "CRUD: Create a payment method" operation, updated the description of the AccountId field.
• For the "Run a report" operation, added the missing request body and the corresponding example.

October 11, 2024

API updates

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

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

• Product Rate Plan Charges - Made the following updates:
  • In the request body of the "CRUD: Create a product rate plan charge" operation, added the ReflectDiscountInNetAmount field.
  • In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, added the ReflectDiscountInNetAmount field.
  • In the 200 response body of the "Retrieve a product rate plan charge" operation, added the reflectDiscountInNetAmount field.
• Orders - Made the following updates:
  • In the request body of the "Create an order" operation, added the following nested fields to the subscriptions > orderActions > termsAndConditions field:
    • scheduledCancelDate
    • scheduledSuspendDate
    • scheduledResumeDate
    • clearingScheduledCancelDate
    • clearingScheduledSuspendDate
    • clearingScheduledResumeDate
  • In the response body of each of the following operations:
    • 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

    Added the following nested fields to the orders > subscriptions > orderActions > termsAndConditions field:

    • scheduledCancelDate
    • scheduledSuspendDate
    • scheduledResumeDate
  • In the response body of the "Retrieve an order" operation, added the following nested fields to the order > subscriptions > orderActions > termsAndConditions field:
    • scheduledCancelDate
    • scheduledSuspendDate
    • scheduledResumeDate
  • In the request body of the "Revert an order" operation, added the orderDate field.
• Subscriptions - Made the following updates:
  • Added a new operation called "List subscriptions metrics by subscription numbers".
  • In the response body of each of the following operations:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version

    Added the following fields:

    • ratePlans > ratePlanCharges > reflectDiscountInNetAmount
    • netTotalContractedValue
  • In the response body of the "List subscriptions by account key" operation, added the following fields:
    • subscriptions > ratePlans > ratePlanCharges > reflectDiscountInNetAmount
    • netTotalContractedValue
  • Updated the description of the getDetailedMetrics query parameter in each of the following operations:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
    • List subscriptions by account key
  • In the response body of the "List subscriptions by account key" operation, added the following nested fields to the subscriptions field:
    • scheduledCancelDate
    • scheduledSuspendDate
    • scheduledResumeDate
  • In the response body of each of the "Retrieve a subscription by key" and "Retrieve a subscription by key and version" operations, added the following fields:
    • scheduledCancelDate
    • scheduledSuspendDate
    • scheduledResumeDate
  • In the response body of each of the following operations, added the originalListPrice nested field to the ratePlans > ratePlanCharges field:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
  • In the response body of the "List subscriptions by account key" operation, added the originalListPrice nested field to the subscriptions > ratePlans > ratePlanCharges field.
• Invoices - Made the following updates:
  • In the 200 response body of the "List all items of an invoice" operation, added the invoiceItems > reflectDiscountInNetAmount field.
  • Made the following updates to the "Retrieve the PDF file generation status of invoices" operation:
    • Updated the description of the invoiceKeys query parameter.
    • In the invoiceFiles field of the response body, added the following nested fields:
      • pdfFileURL
      • errorCategory
      • errorMessage
    • In the response body, removed the Archived status from the invoiceFiles > pdfGenerationStatus field.
    • Updated the response sample.
• Credit Memos - Made the following updates:
  • In the 200 response body of the "List credit memo items" operation, added the items > reflectDiscountInNetAmount field.
  • In the 200 response body of the "Retrieve a credit memo item" operation, added the reflectDiscountInNetAmount field.
  • Made the following updates to the "Retrieve the PDF file generation status of credit memos" operation:
    • Updated the description of the creditMemoKeys query parameter.
    • In the creditMemoFiles field of the response body, added the following nested fields:
      • pdfFileURL
      • errorCategory
      • errorMessage
    • In the response body, removed the Archived status from the creditMemoFiles > pdfGenerationStatus field.
    • Updated the response sample.
• Debit Memos - Made the following updates:
  • In the 200 response body of the "List debit memo items" operation, added the items > reflectDiscountInNetAmount field.
  • In the 200 response body of the "Retrieve a credit memo item" operation, added the reflectDiscountInNetAmount field.
  • Made the following updates to the "Retrieve the PDF file generation status of debit memos" operation:
    • Updated the description of the debitMemoKeys query parameter.
    • In the debitMemoFiles field of the response body, added the following nested fields:
      • pdfFileURL
      • errorCategory
      • errorMessage
    • In the response body, removed the Archived status from the debitMemoFiles > pdfGenerationStatus field.
    • Updated the response sample.
• Payment Methods - Made the following updates:
  • In the request body of the "Update a payment method" operation, added the following fields:
    • maxConsecutivePaymentFailures
    • paymentRetryWindow
    • useDefaultRetryRule
  • In the response body of the "Retrieve a payment method" operation, added the cardBinInfo field.
• Payment Runs - In the request body and response body of the "Create a payment run" operation, added the useCustomPaymentMethods field.
• Object Queries - Made the following updates:
  • Added the reflectDiscountInNetAmount field to the Credit Memo Item object. You can access these fields through the following operations:
    • Retrieve a rate plan charge
    • List rate plan charges
    • List credit memo items
    • Retrieve a credit memo item
    • List subscriptions
    • Retrieve a subscription
  • Added the reflectDiscountInNetAmount field to the Debit Memo Item object. You can access these fields through the following operations:
    • Retrieve a rate plan charge
    • List rate plan charges
    • List debit memo items
    • Retrieve a debit memo item
    • List subscriptions
    • Retrieve a subscription
  • Added the reflectDiscountInNetAmount field to the Invoice Item object. You can access these fields through the following operations:
    • List invoice items
    • Retrieve an invoice item
    • List invoices
    • Retrieve an invoice
    • List subscriptions
    • Retrieve a subscription
    • List taxation items
    • Retrieve a taxation item
    • Retrieve a rate plan charge
    • List rate plan charges

Doc updates

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

• In the 200 response body of the "Retrieve a product rate plan charge" operation, corrected the availability note of each of the following fields:
  • excludeItemBillingFromRevenueAccounting
  • excludeItemBookingFromRevenueAccounting
• In the request body of the "Create fulfillments" operation, corrected the availability note of each of the following fields:
  • fulfillments > excludeItemBillingFromRevenueAccounting
  • fulfillments > excludeItemBookingFromRevenueAccounting
• In the request body of the "Update a fulfillment" operation, corrected the availability note of each of the following fields:
  • excludeItemBillingFromRevenueAccounting
  • excludeItemBookingFromRevenueAccounting
• In the 200 response body of the "Retrieve a fulfillment" operation, corrected the availability note of each of the following fields:
  • fulfillment > excludeItemBillingFromRevenueAccounting
  • fulfillment > excludeItemBookingFromRevenueAccounting
• In the request body of each of the following operations, added the missing invoiceSeparately nested field to the subscriptions > orderActions > termsAndConditions field:
  • Create an order
  • Create an order asynchronously
  • Update an order
• In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Updated the description of each of the following fields for better clarity:

  • subscriptions > orderActions > addProduct > chargeOverrides > billing > billingPeriodAlignment
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > billing > billingPeriodAlignment
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > billing > billingPeriodAlignment
  • subscriptions > orderActions > updateProduct > chargeUpdates > billing > billingPeriodAlignment
• In the request body of the "Create an order" operation, updated the description of the processingOptions > writeOff field for better clarity.
• In the request body of each of the "Create an order" and "Create an order asynchronously" operations, added the string maximum length for the subscriptions > orderActions > changeReason field.
• In the request body of the "Update a subscription" operation, corrected the availability note of each of the following fields:
  • add > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • add > chargeOverrides > excludeItemBookingFromRevenueAccounting
  • change > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • change > chargeOverrides > excludeItemBookingFromRevenueAccounting
• In the request body of each of the following operations, updated the description of the revenueImpacting field:
  • Write off an invoice
  • Write off a debit memo
• In the response body of each of the following operations, updated the description of the revenueImpacting field:
  • List credit memos
  • Retrieve a credit memo
• In the response body of the "List credit memo items" operation, updated the description of the items > revenueImpacting field.
• In the response body of the "Retrieve a credit memo item" operation, updated the description of the revenueImpacting field.
• Updated the description of the "Create a payment session" operation for better clarity.
• Updated the description of each of the following operations to add a reference to the use case article in the Knowledge Center:
  • Cancel a payment schedule
  • Refund a payment
  • Refund a payment with auto-unapplying
• For the "Describe an object" operation, removed the incorrectly documented 4XX error response.

September 27, 2024

API updates

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

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

• Payment Methods - Added a "Retrieve the balance of a bank account" operation.

September 23, 2024

API updates

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

• We have reverted the API documentation updates in the Invoices, Credit Memos, and Debit Memos sections published on September 20, 2024. These changes will be delivered in an upcoming release.

September 20, 2024

API updates

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

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

• Invoices - Made the following updates to the "Retrieve the PDF file generation status of invoices" operation:
  • Updated the description of the invoiceKeys query parameter.
  • In the invoiceFiles field of the response body, added the following nested fields:
    • pdfFileURL
    • errorCategory
    • errorMessage
  • In the response body, removed the Archived status from the invoiceFiles > pdfGenerationStatus field.
  • Updated the response sample.
• Credit Memos - Made the following updates to the "Retrieve the PDF file generation status of credit memos" operation:
  • Updated the description of the creditMemoKeys query parameter.
  • In the creditMemoFiles field of the response body, added the following nested fields:
    • pdfFileURL
    • errorCategory
    • errorMessage
  • In the response body, removed the Archived status from the creditMemoFiles > pdfGenerationStatus field.
  • Updated the response sample.
• Debit Memos - Made the following updates to the "Retrieve the PDF file generation status of debit memos" operation:
  • Updated the description of the debitMemoKeys query parameter.
  • In the debitMemoFiles field of the response body, added the following nested fields:
    • pdfFileURL
    • errorCategory
    • errorMessage
  • In the response body, removed the Archived status from the debitMemoFiles > pdfGenerationStatus field.
  • Updated the response sample.

Doc updates

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

• In the "Write off a debit memo" operation, made the following updates:
  • In the description, added a note to clarify the availability permission required to use this operation.
  • In the request body, corrected the description of the revenueImpacting field.
• In the request body of the "Write off an invoice" operation, made the following updates:
  • Updated the description for each of the following fields to add the availability permission required to use these fields:
    • revenueImpacting
    • amount
    • nonRevenueWriteOffAccountingCode
  • Corrected the description of the amountWithoutTax field.
  • Added the missing items > taxationItems nested field.

September 13, 2024

API updates

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

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

• Orders - Made the following updates:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order

    Added the following fields:

    • subscriptions > orderActions > addProduct > isAddingSubsetCharges
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > isAddingSubsetCharges
    • subscriptions > orderActions > updateProduct > isAddingSubsetCharges
  • In the request body of the "Update an order" operation, added the productRatePlanChargeNumber and productRatePlanChargeId nested fields to the subscriptions > orderActions > updateProduct > chargeUpdates field.
• Product Charge Definitions - In the response body of the "Create product charge definitions" operation, made the following updates:
  • Removed the productChargeDefinitions field.
  • Added the following fields:
    • results
    • success
    • summary
• Settings - Made the following updates:
  • Added the Delivery enum value to the chargeModels parameter of the ChargeModels setting.
  • Added the taxGroupingRule parameter to the BillingRules setting.

  See 200 response sample in JSON format.

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:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Updated the description of each of the following fields for better clarity:

  • subscriptions > orderActions > addProduct > chargeOverrides > chargeNumber
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeNumber
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeNumber
• In the request body of each of the "Create a standalone invoice" and "Create standalone invoices" operations, corrected the data type of the invoiceItems > quantity field on the Invoice object from string to number.
• In the request body of the "Refund a payment with auto-unapplying" operation, deleted the incorrectly documented default value for the writeOffOptions field.
• In the request body of the "Create a payment schedule" operation, deleted the incorrectly documented default value for the billingDocument field.
• In the request body of the "Create a payment schedule" operation, added the default value for the billingDocument > type field.
• Made the following updates to the Settings API:
  • Updated the description of each of the following operations for better clarity:
    • Submit settings requests
    • List all settings
  • Added the following missing enum values to the chargeModels parameter of the ChargeModels setting:
    • HighWaterMarkTieredPricing
    • HighWaterMarkVolumePricing
    • MultiAttributePricing
    • PreratedPerUnit
    • PreratedPricing

  See 200 response sample in JSON format.

September 5, 2024

API updates

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

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

API updates for Single Version Subscription feature

The following items are the API updates specific to the Single Version Subscription feature.

• Orders - Made the following updates:
  • Added the "Revert an order" operation.
  • In the description of the "Delete an order" operation, updated information about the reverted order.
  • In the response body of each of the following operations, updated the description of the orders > status field for reverted orders:
    • List orders
    • List orders of a subscription owner
    • List orders by subscription number
    • List orders of an invoice owner
  • In the response body of the "Retrieve an order" operation, updated the description of the order > status field for reverted orders.
• Subscription Change History - Added the "Subscription Change History" section that contains the following operations:
  • List change histories of a subscription
  • List change histories of subscriptions by order number
  • Retrieve a change history of a subscription by version
• Object Queries - Made the following updates:
  • In the response body of each of the "List accounts" and "Retrieve an account" operations, updated the description of each of the following fields on the Subscription object to clarify that these fields are not available for single version subscriptions:
    • subscriptions > creatorAccountId
    • subscriptions > creatorInvoiceOwnerId
    • subscriptions > isLatestVersion
    • subscriptions > originalId
    • subscriptions > previousSubscriptionId
    • subscriptions > subscriptionVersionAmendmentId
  • In the response body of each of the "List subscriptions" and "Retrieve a subscription" operations, updated the description of each of the following fields on the Subscription object to clarify that these fields are not available for single version subscriptions:
    • creatorAccountId
    • creatorInvoiceOwnerId
    • isLatestVersion
    • originalId
    • previousSubscriptionId
    • subscriptionVersionAmendmentId
  • In the response body of each of the "List rate plans" and "Retrieve a rate plan" operations, made the following updates:
    • Updated the description of each of the following fields on the Rate Plan object to clarify that these fields are not available for single version subscriptions:
      • amendmentId
      • amendmentType
      • subscriptionOfferId
    • Updated the description of each of the following fields on the Subscription object to clarify that these fields are not available for single version subscriptions:
      • subscription > creatorAccountId
      • subscription > creatorInvoiceOwnerId
      • subscription > isLatestVersion
      • subscription > originalId
      • subscription > previousSubscriptionId
      • subscription > subscriptionVersionAmendmentId

Doc updates

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

• Updated the request and response examples of a number of operations across different sections to provide better-structured code samples.
• Renamed the "Scim" section to "SCIM", and updated its description.

The following changes are applicable to the Older API Reference:

• Updated the request and response examples of several operations across different sections to provide better-structured code samples.

August 29, 2024

API updates

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

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

API updates for flexible billing attributes on order line items

The following API updates are specific to the enhancements of the flexible billing attributes on the order line items.

• Orders - Made the following updates:
  • In the request body of each of the following operations，added the paymentTerm and invoiceTemplateId nested fields to the orderLineItems field:
    • Preview an order
    • Preview an order asynchronously
    • Create an order
    • Create an order asynchronously
  • In the response body of each of the following operations, added the paymentTerm and invoiceTemplateId nested fields to the orders > orderLineItems 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
  • In the response body of the "Retrieve an order" operation, added the paymentTerm and invoiceTemplateId nested fields to the order > orderLineItems field.
• Order Line Items - Made the following updates:
  • In the request body of the "Update order line item" operation，added the paymentTerm and invoiceTemplateId fields.
  • In the request body of the "Update order line items" operation，added the paymentTerm and invoiceTemplateId nested fields to the orderLineItems field.
  • In the response body of the "Retrieve an order line item" operation, added the paymentTerm and invoiceTemplateId nested fields to the orderLineItem field.

Other API updates

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

• Scim - Added the "Scim" section that contains the following operations:
  • List groups
  • Create a group
  • Bulk create groups
  • Bulk update groups
  • Bulk delete groups
  • Retrieve a group
  • Update a group
  • Delete a group
  • Partially update a group
  • List all resource types
  • Retrieve a resource type
  • List all schemas of resources
  • List schemas of a resource
  • Retrieve the service provider configuration
  • List users
  • Create a user
  • Bulk create users
  • Bulk update users
  • Delete a list of users
  • Retrieve a user
  • Update a user
  • Delete a user
  • Partially update a user
• Debit Memos - Added a "Write off a debit memo" operation.
• Payment Methods - Made the following updates for a system behavior change for orphan payment methods:
  • Updated the description of the "Create a payment method" operation.
  • In the request body of the "Create a payment method" operation, updated the description of the accountKey field.
  • In the request body of the "Create an Apple Pay payment method" operation, updated the description of the accountID field.

August 23, 2024

API updates

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

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

• API Health - Added a "List API Failure records" operation.

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 Order Metrics related objects and fields for better clarity:
  • the Order Item object
  • the Order ELP object
  • the generatedReason and orderItemId fields of the Order MRR, Order TCB, Order TCV, and Order Quantity objects

  The following operations are affected:

  • Preview an order
  • Retrieve an order
  • 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
• Updated the description of each of the following operations for better clarity:
  • Preview a subscription by subscription key
  • List subscriptions by account key
  • Retrieve a subscription by key
  • Update a subscription
  • Retrieve a subscription by key and version
  • Renew a subscription
  • Cancel a subscription
  • Resume a subscription
  • Suspend a subscription
• In the request body of the "Update a payment schedule" operation, added the missing description field.
• In the description of the "List all settings" operation, added the following sections:
  • Zuora Tax Rate Period
  • Zuora Tax Code
  • Zuora Tax Rate
• In the "Restore a file" operation, corrected the sample cURL request.

August 16, 2024

API updates

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

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

• Accounts - Made the following updates:
  • In the request body of each of the following operations, added a nested custom field to the einvoiceProfile field:
    • Create an account
    • Update an account
  • In the response body of the "Retrieve an account" operation, added a nested custom field to the einvoiceProfile field.

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 fields on the Payment Method object for better clarity:
  • active
  • isSystem

  You can access these fields through the following Object Queries operations:

  • Retrieve an account
  • List accounts
  • Retrieve a payment
  • List payments
  • Retrieve a payment method
  • List payment methods
  • Retrieve a refund
  • List refunds
  • Retrieve a payment method snapshot
  • List payment method snapshots

August 9, 2024

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 summaryStatementTemplateId field for better clarity:
  • Create an account
  • Update an account
• In the request body of each of the following operations, updated the description of the subscriptions > orderActions > changePlan > resetBcd field for better clarity:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously
• For each of the following Object Queries operations, added the missing rateplans.rateplancharges.rateplanchargetiers enum value to the expand[] query parameter:
  • List subscriptions
  • Retrieve a subscription
• For the "Create a payment session" operation, made the following updates:
  • In the request body, updated the description of each of the following fields to clarify the field requirements:
    • amount
    • invoices
  • In the response body, updated the description of the token field for better clarity.
• In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Updated the description of each of the following fields to remove the incorrect requirement for setting a WSDL version:

  • subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
  • subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption
• In the response body of each of the following operations:
  • 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

  Updated the description of each of the following fields to remove the incorrect requirement for setting a WSDL version:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption
• In the response body of the "Retrieve an order" operation, updated the description of each of the following fields to remove the incorrect requirement for setting a WSDL version:
  • order > subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
  • order > subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType

August 2, 2024

API updates

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

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

• Accounts - In the request body of each of the following operations, added the summaryStatementTemplateId field :
  • Create an account
  • Update an account
• Payment Methods - In the request body of the "Create a payment method" operation, made the following updates for the support of payment method tokenization:
  • For the PayPalCP payment method type, added the following fields:
    • tokenize
    • tokens
  • For the CreditCard payment method type, updated the description of each of the following fields:
    • cardMaskNumber
    • tokens

Doc updates

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

• In the response body of the "Retrieve an account" operation, added the description for the summaryStatementTemplateId field for better clarity.
• Updated the description of the billTo field of the OrderLineItem object for better clarity. The following operations are affected:
  • Retrieve an order line item
  • Update an order line item
  • Update order line items
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order
  • 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
  • Retrieve an order
• In the request body of the "Cancel a payment schedule" operation, updated the description of the cancelDate field for better clarity.
• Updated the description of the "List all settings" operation by adding a link to the article about creating a notification definition under a particular communication profile.

July 26, 2024

API updates

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

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

API updates for Dynamic Usage Charges feature

The following API updates are specific to the Dynamic Usage Charges feature.

• Usage - Made the following updates:
  • In the request body of the "CRUD: Create a usage record" operation, added the ProductRatePlanChargeNumber field.
  • In the response body of the "CRUD: Retrieve a usage record" operation, added the ProductRatePlanChargeNumber field.
  • In the response body of the "Retrieve a usage record" operation, added the usage > productRatePlanChargeNumber field.
  • In the template usage file that is uploaded by the "Upload a usage file" operation, added the PRODUCT_RATE_PLAN_CHARGE_ID column.
• Object Queries - Added the productRatePlanChargeId field to the Usage Record object. You can access this field through the following Object Queries operations:
  • Retrieve a usage record
  • List usage records
  • Retrieve an account
  • List accounts
• Regenerate - In the request body of the "Regenerate booking transactions" operation, made the following updates:
  • Added the ratePlanChargeId field
  • Added the chargeNumber field
  • Added the DynamicUsageCharge enum value to the type field

API updates for Charge Level Proration feature enhancements

The following API updates are specific to the enhancements of the Charge Level Proration feature.

• Orders - In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Added the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride
  • subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > daysInMonth
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > daysInMonth
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > daysInMonth

  Added the CustomizeProrationOptionOverrides enum value to each of the following the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption
• In the response body of each of the following operations:
  • 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

  Added the following fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > daysInMonth
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > daysInMonth
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > daysInMonth

  Added the CustomizeProrationOptionOverrides enum value to each of the following the following fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption
• In the response body of the "Retrieve an order" operation:

  Added the following fields:

  • order > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride
  • order > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • order > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • order > subscriptions > orderActions > addProduct > chargeOverrides > ratingPropertiesOverride > daysInMonth
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > ratingPropertiesOverride > daysInMonth
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > isProratePartialMonth
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > prorationUnit
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > ratingPropertiesOverride > daysInMonth

  Added the CustomizeProrationOptionOverrides enum value to each of the following the following fields:

  • order > subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption

Other API updates

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

• Orders - In the request body of each of the following operations, updated the description of the subscriptions field for the support of creating an order that contains multiple subscriptions with different invoice owner accounts:
  • Create an order
  • Create an order asynchronously
• Operations - In the request body of the "Export bulk PDF files" operation, added the FailedDocuments field.
• Payment Methods - In the request body of the "Create a payment method" operation, made the following updates for the support of payment method tokenization:
  • For the ACH payment method type, made the following changes:
    • Added the tokenize field.
    • Updated the description of the bankName field.
  • For the CreditCard payment method type, updated the description of the tokenize field.
  • For the SEPA payment method type, updated the description of each of the following fields:
    • accountMaskNumber
    • accountHolderInfo
    • IBAN
    • tokens

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, corrected the maximum length of the personalEmail field to 80 from 74:
  • Create a contact
  • Update a contact
• In the response body of each of the following operations, corrected the maximum length of the personalEmail field of the Contact object to 80 from 74:
  • Create a contact
  • Update a contact
  • Retrieve a contact
  • Object Query: Retrieve a contact
  • Object Query: List contacts
• In the request body of the "Create an account" operation, updated the description of the sequenceSetId field for better clarity.
• In the request body of the "Update order line items" operation, updated the description of the orderLineItems > sequenceSetId field for better clarity.
• In the request body of the "Update an order line item" operation, updated the description of the sequenceSetId field for better clarity.
• In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Added the following missing fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption

  Corrected the permission required for each of the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
  • subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
• In the response body of each of the following operations:
  • 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

  Added the following missing fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption

  Corrected the permission required for each of the following fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
• In the response body of the "Retrieve an order" operation:

  Added the following missing fields:

  • order > subscriptions > orderActions > addProduct > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > prorationOption
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > prorationOption

  Corrected the permission required for each of the following fields:

  • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
  • order > subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
• Added the missing prorationOption field on the Product Rate Plan Charge object. You can access this field through the following Object Queries operations:
  • List products
  • Retrieve a product
  • List product rate plans
  • Retrieve a product rate plan
  • List product rate plan charges
  • Retrieve a product rate plan charge
  • List product rate plan charge tiers
  • Retrieve a product rate plan charge tier
  • List rate plan charges
  • Retrieve a rate plan charge
• In the request body of each of the following operations:
  • CRUD: Create a product rate plan charge
  • CRUD: Update a product rate plan charge

  Added the missing ProrationOption field and corrected the permission required for each of the following fields:

  • ChargeFunction
  • CommitmentType
• In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, added the missing ProrationOption field and corrected the permission required for each of the following fields:
  • ChargeFunction
  • CommitmentType
• In the 200 response body of the "Retrieve a product rate plan charge" operation, added the missing prorationOption field and corrected the permission required for each of the following fields:
  • chargeFunction
  • commitmentType
• In the response body of each of the following operations:
  • Retrieve a subscription by key
  • Retrieve a subscription by key and version

  Corrected the permission required for each of the following fields:

  • ratePlans > ratePlanCharges > chargeFunction
  • ratePlans > ratePlanCharges > commitmentType
• In the response body of the "List subscriptions by account key" operation, corrected the permission required for each of the following fields:
  • subscriptions > ratePlans > ratePlanCharges > chargeFunction
  • subscriptions > ratePlans > ratePlanCharges > commitmentType
• In the request body of each of the following operations, updated the description of the id query parameter for better clarity.
  • Delete a sequence set
  • Retrieve a sequence set
  • Update a sequence set
• Updated the description of the "Create a payment method" operation to clarify the required fields for payment method tokenization.

July 19, 2024

API updates

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

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

• Credit Memos - In the request body of each of the following operations, updated the description of the customRates field for a behavior change:
  • Create a credit memo from a charge
  • Refund a credit memo
• Debit Memos - In the request body of the "Create a debit memo from a charge" operation, updated the description of the customRates field for a behavior change.
• Invoices - In the request body of each of the following operations, updated the description of the customRates field of the Invoice object for a behavior change:
  • Create a standalone invoice
  • Create standalone invoices
• Payments - In the request body of each of the following operations, updated the description of the customRates field for a behavior change:
  • Create a payment
  • Refund a payment

Doc updates

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

• In the "Retrieve a payment schedule" operation, added the missing cancellationReason field in the response body and response sample code.
• In the "Retrieve a payment schedule item" operation, made the following changes:
  • Added the following missing fields to the response body:
    • cancelledById
    • cancelledOn
  • Updated the response sample code.
• In the request body of each of the following operations, corrected the type of the invoiceItems > amount field from string to number:
  • Create a standalone invoice
  • Update an invoice
• In the request body of each of the following operations, corrected the type of the invoices > invoiceItems > amount field from string to number:
  • Create standalone invoices
  • Update invoices
• In the response body of the "Retrieve an account" operation, corrected the data type of the billingAndPayment > billCycleDay field from string to integer, and updated the data format of this field to int64.

July 12, 2024

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 "Create an order" and "Create an order asynchronously" operations, updated string maximum length for the orderLineItems > description field.
• In the description of the "Create an order" operation, added a note to clarify the special characters not allowed in the Orders operations.
• In the description of each of the "Preview an order" and "Preview an order asynchronously" operations, added a note to clarify that these operations do not support previewing usage charges.
• From the following fields of the "Preview an order" and "Preview an order asynchronously" operations:
  • subscriptions > orderActions > addProduct > chargeOverrides > pricing
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing
  • subscriptions > orderActions > updateProduct > chargeUpdates > pricing

  Removed the following unsupported fields:

  • usageFlatFee
  • usageOverage
  • usagePerUnit
  • usageTiered
  • usageTieredWithOverage
  • usageVolume

July 4, 2024

API updates

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

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

• Settings - For each of the following settings:
  • AllTaxEngines
  • CreateGlobalTaxHubTaxEngine
  • GlobalTaxHubTaxEngine

  Made the following updates:

  • Added the oauthScope parameter.
  • Added the OneSource_REST enum value to the vendor parameter.

  See 200 response sample in JSON format.

Doc updates

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

• In the response body of each of the following operations, updated the description of the ratePlans > ratePlanCharges > rolloverPeriodLength field for better clarity.
  • Retrieve a subscription by key
  • Retrieve a subscription by key and version
• In the response body of the "List subscriptions by account key" operation, updated the description of the subscriptions > ratePlans > ratePlanCharges > rolloverPeriodLength field for better clarity.
• In the request body of each of the following operations, updated the description of the RolloverPeriodLength field for better clarity.
  • CRUD: Create a product rate plan charge
  • CRUD: Update a product rate plan charge
• In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, updated the description of the RolloverPeriodLength field for better clarity.
• In the 200 response body of the "Retrieve a product rate plan charge" operation, updated the description of the rolloverPeriodLength field for better clarity.
• In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Updated the description of each of the following fields for better clarity:

  • subscriptions > orderActions > addProduct > chargeOverrides > rolloverPeriodLength
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > rolloverPeriodLength
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > rolloverPeriodLength
• In the response body of each of the following operations:
  • 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

  Updated the description of each of the following fields for better clarity:

  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > rolloverPeriodLength
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > rolloverPeriodLength
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > rolloverPeriodLength
• In the response body of the "Retrieve an order" operation, updated the description of each of the following fields for better clarity:
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > rolloverPeriodLength
  • order > subscriptions > orderActions > addProduct > chargeOverrides > rolloverPeriodLength
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > rolloverPeriodLength
• Updated the description of the rolloverPeriodLength field on the Rate Plan Charge object for better clarity. You can access this field through the following Object Queries operations:
  • Retrieve a rate plan
  • List rate plans
  • Retrieve a rate plan charge
  • List rate plan charges
  • List credit memo items
  • Retrieve a credit memo item
  • List debit memo items
  • Retrieve a debit memo item
  • List invoice items
  • Retrieve an invoice item
  • List rating results
  • Retrieve a rating result
• Updated the description of the rolloverPeriodLength field on the Product Rate Plan Charge object for better clarity. You can access this field through the following Object Queries operations:
  • List products
  • Retrieve a product
  • List product rate plans
  • Retrieve a product rate plan
  • List product rate plan charges
  • Retrieve a product rate plan charge
  • List product rate plan charge tiers
  • Retrieve a product rate plan charge tier
  • List rate plan charges
  • Retrieve a rate plan charge
• In the request body of the "Create a payment session" operation, updated the description of each of the following fields for better clarity:
  • accountId
  • invoices
• In the request body of each of the following operations, corrected the memos > invoiceId field to required and updated the field description for better clarity:
  • Create credit memos
  • Create debit memos
• Updated the description of the "Unapply a credit memo" operation for better clarity.
• Added multiple payload examples to the "Update a callout template" operation.
• For the "List taxation items" and "Retrieve a taxation item" Object Queries operations, added the missing description for each of the following fields:
  • customerCode
  • sellerRegistration
  • balance

June 28, 2024

API updates

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

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

• Notifications - Added the following operations:
  • Create or update callout templates
  • Create a callout template
  • List callout templates
  • Retrieve a callout template
  • Update a callout template
  • Delete a callout template

Doc updates

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

• Updated the description of the Zuora-Entity-Ids header field for better clarity.
• Removed the unsupported sort[] query parameters from the "List custom objects" and "Retrieve a custom object" operations.
• Updated the description of the "Object Query" section for better clarity.

June 26, 2024

API updates

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

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

• Payment Methods - In the request body of the "Create a payment session" operation, made the following updates for support of Payment Form implementation:
  • Added the following fields:
    • storePaymentMethod
    • invoices
  • Updated the description of each of the following fields:
    • amount
    • authAmount
    • paymentGateway
    • processPayment

Doc updates

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

• Updated the description of the "Create a payment" operation for better clarity.

June 21, 2024

API updates

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

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

API updates for Standalone Orders feature enhancements

The following items are the API updates specific to the enhancements of the Standalone Orders feature.

• Orders - In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Added the following fields to support setting the configurations for the Order to Revenue feature in a standalone order:

  • subscriptions > orderActions > addProduct > chargeOverrides > revenueRecognitionTiming
  • subscriptions > orderActions > addProduct > chargeOverrides > revenueAmortizationMethod
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > revenueRecognitionTiming
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > revenueAmortizationMethod
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > revenueRecognitionTiming
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > revenueAmortizationMethod

API updates for availability permission change in Advanced Consumption Billing feature

• Usage - Made the following updates:
  • In the request body of the "CRUD: Create a usage record" operation, changed the availability permission required to use the UniqueKey field.
  • In the response body of the "Retrieve a usage record" operation, changed the availability permission required to use the usage > uniqueKey field.
• Object Queries - Changed the availability permission required to use the uniqueKey field of the Usage Record object. You can access this field through the following operations:
  • Retrieve a usage record
  • List usage records
  • Retrieve an account
  • List accounts

API updates for Payment Schedules enhancements

The following items are specific to the Payment Schedules feature:

• Payment Schedules - Made the following updates:
  • In the request body of the "Create a payment schedule" operations, added the billingDocuments field.
  • In the request body of the "Create multiple payment schedules at once" operation, added the paymentSchedules > billingDocuments nested field.
  • In the response body of each of the following operations, added the billingDocuments field:
    • Create a payment schedule
    • Retrieve a payment schedule
    • List payment schedules by customer account

Other API updates

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

• Orders - In the request body of each of the following operations, added the processingOptions > electronicPaymentOptions > gatewayOptions nested field:
  • Create an order
  • Create an order asynchronously
  • Update an order
• Payment Authorization - In the request body of the "Cancel authorization" operation, updated the description of each of the following fields for a system behavior change:
  • accountId
  • accountNumber
  • paymentGatewayId
• Payment Profiles - Added the "Payment Profiles" section that contains the following operation:
  • Create or update payment profiles in bulk

Doc updates

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

• Added the missing revenueRecognitionTiming and revenueAmortizationMethod fields to the Rate Plan Charge object. You can access these fields through the following operations:
  • Retrieve a rate plan
  • List rate plans
  • Retrieve a rate plan charge
  • List rate plan charges
  • List credit memo items
  • Retrieve a credit memo item
  • List debit memo items
  • Retrieve a debit memo item
  • List invoice items
  • Retrieve an invoice item
  • List prepaid balance funds
  • Retrieve a prepaid balance fund
  • List rating results
  • Retrieve a rating result

June 14, 2024

API updates

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

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

API updates for Specialized Payment Connections integrations

The following items are the API updates specific to payment method tokenization on certain integrations requested through the Specialized Payment Connections service.

• Payment Methods - In the request body of the "Create a payment method" operation, added the following fields for the CreditCard payment method type:
  • cardMaskNumber
  • tokenize
  • tokens
• Accounts - In the request body of the "Create an account" operation, added the following fields for the CreditCard payment method type:
  • paymentMethod > cardMaskNumber
  • paymentMethod > tokenize
  • paymentMethod > tokens
• Orders - In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously

  Added the following fields for the CreditCard payment method type:

  • newAccount > paymentMethod > cardMaskNumber
  • newAccount > paymentMethod > tokenize
  • newAccount > paymentMethod > tokens

Doc updates

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

• Added the missing orderId field to the Subscription object in the following Object Queries operations:
  • List accounts
  • Retrieve an account
  • List order actions
  • Retrieve an order action
  • List rate plans
  • Retrieve a rate plan
  • List rating results
  • Retrieve a rating result
  • List invoice items
  • Retrieve an invoice item
  • List debit memo items
  • Retrieve a debit memo item
  • List credit memo items
  • Retrieve a credit memo item
  • List prepaid balances
  • Retrieve a prepaid balance
• Updated the description of the "Create a payment session" operation for better clarity.

June 7, 2024

Doc updates

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

• Added the missing paymentMethodCascadingConsent field to the expanded account object. The following Object Queries operations are affected:
  • List subscriptions
  • Retrieve a subscription
  • List credit memos
  • Retrieve a credit memo
  • List debit memos
  • Retrieve a credit memo
  • List invoices
  • Retrieve an invoice
  • List orders
  • Retrieve an order
  • List payments
  • Retrieve a payment
  • List payment methods
  • Retrieve a payment method
  • List prepaid balance
  • Retrieve a prepaid balance
  • List prepaid balance transactions
  • Retrieve a prepaid balance transaction
  • List rating results
  • Retrieve a rating result
  • List Refunds
  • Retrieve a refund
  • List usage records
  • Retrieve a usage record
  • List validity period summaries
  • Retrieve a validity period summary

May 30, 2024

API updates

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

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

API updates for E-Invoicing

The following items are the API updates specific to the E-Invoicing feature.

• E-Invoicing - Made the following updates:
  • In the request body of the "Create an e-invoicing business region" operation, added the following fields:
    • processType
    • invoiceEnabled
    • creditMemoEnabled
    • debitMemoEnabled
  • In the response body of the "List e-invoicing business regions" operation, added the following nested fields to the regions field:
    • processType
    • invoiceEnabled
    • creditMemoEnabled
    • debitMemoEnabled
  • In the request body of the "Create an e-invoicing business region" operation, updated the description of the responseMapping for better clarity.
  • In the response body of the "List e-invoicing business regions" operation, updated the description of the regions > responseMapping nested field for better clarity.
  • In the request body of the "Create an e-invoicing service provider" operation, added the Avalara enum value to the provider field.
  • In the response body of each of the following operations，added the Avalara enum value to the provider field:
    • Create an e-invoicing service provider
    • Retrieve an e-invoicing service provider
  • In the response body of the "List e-invoicing service providers" operation, added the Avalara enum value to the serviceProviders > provider field.
  • In the request body of the "Create an e-invoicing service provider" operation, updated the description of each of the following fields to clarify the required fields for different service providers:
    • apiKey
    • secretKey
  • In the request body of the "Update an e-invoicing service provider" operation, updated the description of each of the following fields to clarify the required fields for different service providers:
    • apiKey
    • secretKey
    • clientCertificate
    • clientCertificateType
    • clientCertificatePassword
  • In the response body of each of the following operations:
    • Create an e-invoicing service provider
    • Update an e-invoicing service provider
    • Retrieve an e-invoicing service provider

    Updated the description of each of the following fields to clarify the required fields for different service providers:

    • apiKey
    • clientCertificate
    • clientCertificateType
  • In the response body of the "List e-invoicing service providers" operation, updated the description of each of the following fields to clarify the required fields for different service providers:
    • serviceProviders > apiKey
    • serviceProviders > clientCertificate
    • serviceProviders > clientCertificateType

Other API updates

• Subscriptions - Made the following updates:
  • In the response body of each of the following operations, added the salesPrice nested field to the ratePlans > ratePlanCharges field:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
  • In the response body of the "List subscriptions by account key" operation, added the salesPrice nested field to the subscriptions > ratePlans > ratePlanCharges field.
• Object Queries - Made the following updates:
  • Added the salesPrice field to the Rate Plan Charge object. You can access this field through the following operations:
    • Retrieve a rate plan
    • List rate plans
    • Retrieve a rate plan charge
    • List rate plan charges
    • List credit memo items
    • Retrieve a credit memo item
    • List debit memo items
    • Retrieve a debit memo item
    • List invoice items
    • Retrieve an invoice item
    • List prepaid balance funds
    • Retrieve a prepaid balance fund
    • List rating results
    • Retrieve a rating result
  • Added the orderId field to the Subscription object. You can access this field through the following operations:
    • Retrieve a subscription
    • List subscriptions
• Notifications - Made the following updates:
  • In the request body and 200 response body of each of the following operations, added the PATCH enum value to the callout > httpMethod field:
    • Create a notification definition
    • Update a notification definition
  • In the 200 response body of the "List notification definitions" operation, added the PATCH enum value to the data > callout > httpMethod field.
  • In the 200 response body of the "Retrieve a notification definition" operation, added the PATCH enum value to the callout > httpMethod field.

Doc updates

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

• For each of the following operations, removed the unsupported Idempotency-Key request header parameter:
  • Create custom object definitions
  • Update a custom object definition
  • Create custom object records
  • Partially update a custom object record
  • Update or delete custom object records
  • Submit a custom object bulk job
  • Upload a file for a custom object bulk job
  • Cancel a custom object bulk job

May 23, 2024

API updates

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

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

API updates for new API versioning scheme

The following items are the API updates specific to the new API versioning scheme.

• Moved the "API Verisons" section from this API Reference to a separate page called API versions .
• Removed all version-controlled fields that are not available in the latest minor verison, 2024-05-20 . For details about the fields are no longer available, see API upgrades .
• Updated the description for each of the version-controlled fields that are available in the latest minor verison, 2024-05-20 . For details about the available version-controlled fields, see API upgrades .
• Added the 4XX and 500 responses to each of the operations with an endpoint prefixed with /v1 , except for Actions and CRUD operations.

For more information about the new API versioning scheme, see the following pages:

• API upgrade guide
• Release note: New Zuora v1 API versioning scheme
• Community post: Announcing a new API versioning scheme

Other API updates

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

• Debit Memos - Updated the description of the "List all application parts of a debit memo" operation.
• Data Backfill - Made the following updates:
  • Added the following operations:
    • Create an auto backfill job
    • List all auto backfill jobs
    • Retrieve an auto backfill job
    • Stop an auto backfill job
  • In the response body of the "List all booking date backfill jobs" operation, added the jobs > type field.
  • In the response body of the "Retrieve a booking date backfill job" operation, added the job > type field.

Doc updates

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

• In the description of the "Object Queries" section, updated limitations for better clarity.
• In the "Prepaid with Drawdown" section, added the missing "Deplete funds" operation.
• In the request body of each of the following operations, updated the description of the accountKey field for better clarity:
  • Create a payment method
  • Update a payment method
• Corrected the endpoint of the "Download a data backfill template file" operation.

May 16, 2024

Doc updates

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

• In the response body of each of the following operations:
  • Retrieve a subscription by key
  • Retrieve a subscription by key and version

  Added the following missing fields:

  • contractedNetMrr
  • asOfDayGrossMrr
  • asOfDayNetMrr
• In the description of the "Object Queries" section, updated limitations for better clarity.

May 10, 2024

API updates

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

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

API updates for Standalone Orders feature enhancements

The following items are the API updates specific to the enhancements of the Standalone Orders feature.

• Orders - Made the following changes to support using a standalone order to create a Minimum Commitment subscription:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order
    • Preview an order
    • Preview an order asynchronously

    Added the following fields:

    • subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
    • subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
    • subscriptions > orderActions > addProduct > chargeOverrides > creditOption
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > creditOption
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > creditOption

    Enhanced the following fields:

    • subscriptions > orderActions > addProduct > chargeOverrides > validityPeriodType
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > validityPeriodType
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > validityPeriodType
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > creditOption
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > creditOption
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > creditOption

    Enhanced the following fields:

    • orders > subscriptions > orderActions > addProduct > chargeOverrides > validityPeriodType
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > validityPeriodType
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > validityPeriodType
  • In the response body of the "Retrieve an order" operation:

    Added the following fields:

    • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeFunction
    • order > subscriptions > orderActions > addProduct > chargeOverrides > commitmentType
    • order > subscriptions > orderActions > addProduct > chargeOverrides > creditOption
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeFunction
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > commitmentType
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > creditOption
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeFunction
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > commitmentType
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > creditOption

    Enhanced the following fields:

    • order > subscriptions > orderActions > addProduct > chargeOverrides > validityPeriodType
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > validityPeriodType
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > validityPeriodType

API updates for retrieving account owner details from orders or subscriptions

The following items are the API updates for the retrieving account owner details from orders or subscriptions use case.

• Orders - Made the following updates:
  • In the request body of the "Retrieve an order" operation, added the getAccountDetails query parameter.
  • In the response body of the "Retrieve an order" operation, made the following changes:
    • Added the existingAccountDetails nested field to the order field.
    • Added the subscriptionOwnerAccountDetails nested field to the order > subscriptions field.
  • In the response body of the “Create an order” operation, added the subscriptionOwnerNumber and subscriptionOwnerID fields.
• Subscriptions - Made the following updates:
  • In the request body of the "Retrieve a subscription by key" operation, added the getSubscriptionOwnerDetails and getInvoiceOwnerDetails query parameters.
  • In the response body of the "Retrieve a subscription by key" operation, made the following changes:
    • Added the accountOwnerDetails and invoiceOwnerAccountDetails fields.
    • Updated the description of each of the billToContact and soldToContact fields.

Other API updates

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

• Files - Added the following operations:
  • Restore a file
  • Retrieve file status
• Subscriptions - Made the following updates:
  • In each of the following operations:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version

    Added the following query parameters:

    • getDetailedMetrics
    • asOfDay

    Added the following fields in the response body:

    • contractedNetMrr
    • asOfDayGrossMrr
    • asOfDayNetMrr
    • ratePlans > contractedMrr
    • ratePlans > contractedNetMrr
    • ratePlans > asOfDayGrossMrr
    • ratePlans > asOfDayNetMrr
  • In the "List subscriptions by account key" operation:

    Added the following query parameters:

    • getDetailedMetrics
    • asOfDay

    Added the following fields in the response body:

    • subscriptions > contractedNetMrr
    • subscriptions > asOfDayGrossMrr
    • subscriptions > asOfDayNetMrr
    • subscriptions > ratePlans > contractedMrr
    • subscriptions > ratePlans > contractedNetMrr
    • ratePlans > asOfDayGrossMrr
    • subscriptions > ratePlans > asOfDayNetMrr
• Object Queries - Made the following updates:
  • In the "List invoices" and "Retrieve an invoice" operations, added the following enum values to the expand[] query parameter:
    • invoiceitems.subscription
    • invoiceitems.subscription.account
  • In the "List credit memos" and "Retrieve an credit memo" operations, added the following enum values to the expand[] query parameter:
    • creditmemoitems.subscription
    • creditmemoitems.subscription.account
  • In the "List debit memos" and "Retrieve an debit memo" operations, added the following enum values to the expand[] query parameter:
    • debitmemoitems.subscription
    • debitmemoitems.subscription.account
• Custom Object Definitions - Made the following updates to add support for the Long Text custom field type:
  • Updated the description of the "Create custom object definitions" operation.
  • In the request body of the "Create custom object definitions" operation, updated the description of the definitions > property name* > properties > property name* > maxLength field.
  • In the 200 response body of each of the following operations, updated the description of the definitions > property name* > schema > properties > property name* > maxLength field.
    • Create custom object definitions
    • List custom object definitions
  • In the 200 response body of the "Retrieve a custom object definition" operation, updated the description of the schema > properties > property name* > maxLength field.
  • In the request body and 200 response body of the "Update a custom object definition" operation, updated the description of the actions > field > definition > maxLength field.

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:
  • Preview an order
  • Preview an order asynchronously

  Added the missing DiscountFixedAmount and DiscountPercentage enum values for each of the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel

  Removed the incorrect DiscountFixedAmount and DiscountPercentage enum values from each of the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > chargeType
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
• In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Added the following missing fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeTiered > uom
  • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringTiered > uom
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeTiered > uom
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringTiered > uom
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeTiered > uom
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringTiered > uom
• In the response body of each of the following operations:
  • 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

  Added the following missing fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeTiered > uom
  • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringTiered > uom
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeTiered > uom
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringTiered > uom
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeTiered > uom
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringTiered > uom
• In the response body of the "Retrieve an order" operation, added the following missing fields:
  • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeTiered > uom
  • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringTiered > uom
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeTiered > uom
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringTiered > uom
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeTiered > uom
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringTiered > uom
• In the response body of the "Retrieve an order" operation, added the following missing fields:
  • productRatePlans > productRatePlanCharges > chargeFunction
  • productRatePlans > productRatePlanCharges > commitmentType
• For the following objects in all relevant operations, updated the description of the state field in the request body and response body for better clarity:
  • Bill To Contact
  • Sold To Contact
  • Payment Method
• For the Payment Method object in all relevant Object Queries operations, updated the description of the achState field in the response body for better clarity.
• For the Account object in all relevant Object Queries operations, added the missing paymentMethodCascadingConsent field to the response body.
• In the response body of the "List payment methods of an account" operation, added enum values for the returnedPaymentMethodType > type field.
• In the response body of the "Retrieve the default payment method of an account" operation, added enum values for the type field.
• In the response body of the "Retrieve an account summary" operation, added enum values for the basicInfo > defaultPaymentMethod > paymentMethodType field.
• In the request body of the "Create a journal run" operation, corrected the data type and updated the description of the organizationLabels field.

The following changes are applicable to the Older API Reference:

• In the description of each of the "Amend" and "Subscribe" actions, added a missing note for the deprecation of the Subscribe and Amend features.
• Updated the description of the "Amendments" section for better clarity.

April 29, 2024

API updates

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

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

API updates for deprecation of the Subscribe and Amend features

• Subscriptions - In the description of the "Subscriptions" section and the description of each of the following operations, added a note for the deprecation of the Subscribe and Amend features:
  • Preview a subscription
  • Preview a subscription by subscription key
  • Create a subscription
  • List subscriptions by account key
  • Retrieve a subscription by key
  • Update a subscription
  • Retrieve a subscription by key and version
  • Renew a subscription
  • Cancel a subscription
  • Resume a subscription
  • Suspend a subscription
  • Delete a subscription by number
  • Update subscription custom fields of a subscription version
• Object Queries - In the description of each of the following operations, added a note for the deprecation of the Subscribe and Amend features:
  • List amendments
  • Retrieve an amendment

The following changes apply to the Older API Reference:

• Subscriptions - In the description of the "Subscriptions" section and the description of each of the following operations, added a note for the deprecation of the Subscribe and Amend features:
  • CRUD: Retrieve a subscription
  • CRUD: Update a subscription
  • CRUD: Delete a subscription
• Amendments - In the description of the "Amendments" section and the description of each of the following operations, added a note for the deprecation of the Subscribe and Amend features:
  • Retrieve an amendment
  • Retrieve the last amendment of a subscription
  • CRUD: Retrieve an amendment
  • CRUD: Update an amendment
  • CRUD: Delete an amendment
• Subscription Product Features - In the description of the "Subscription Product Features" section and the description of each of the following operations, added a note for the deprecation of the Subscribe and Amend features:
  • CRUD: Retrieve a subscription product feature

API updates for deprecation of the Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments features

The following changes apply to the Older API Reference:

• Invoice Adjustments - In the description of the "Invoice Adjustments" section and the description of each of the following operations, added a note for the deprecation of the Invoice Adjustment, Invoice Item Adjustment, and Credit Balance Adjustment features:
  • CRUD: Create an invoice adjustment
  • CRUD: Retrieve an invoice adjustment
  • CRUD: Update an invoice adjustment
  • CRUD: Delete an invoice adjustment
• Invoice Item Adjustments - In the description of the "Invoice Item Adjustments" section and the description of each of the following operations, added a note for the deprecation of the Invoice Adjustment, Invoice Item Adjustment, and Credit Balance Adjustment features:
  • CRUD: Create an invoice item adjustment
  • CRUD: Retrieve an invoice item adjustment
  • CRUD: Update an invoice item adjustment
  • CRUD: Delete an invoice item adjustment
• Credit Balance Adjustments - In the description of the "Credit Balance Adjustments" section and the description of each of the following operations, added a note for the deprecation of the Invoice Adjustment, Invoice Item Adjustment, and Credit Balance Adjustment features:
  • CRUD: Create a credit balance adjustment
  • CRUD: Retrieve a credit balance adjustment
  • CRUD: Update a credit balance adjustment

Doc updates

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

• In the following Object Queries operations, corrected the filter[] query parameter to required and updated the description of each of the operations:
  • List rate plan charges
  • List invoice items
  • List payment method snapshots
• In the description of the "Object Queries" section, updated the limitations to clarify that filtering on null or an empty string ( '' ) is not supported.

April 26, 2024

API updates

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

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

• Bill Run - Made the following updates:
  • In the request body of the "Create a bill run" operation, added the following fields:
    • invoiceDateMonthOffset
    • invoiceDateDayOfMonth
    • targetDateMonthOffset
    • targetDateDayOfMonth
    • schedule > monthlyOnEndOfMonth
  • In the response body of each of the following operations:
    • Create a bill run
    • Retrieve a bill run
    • Post a bill run
    • Cancel a bill run
    • Delete a bill run

    Added the following fields:

    • invoiceDateMonthOffset
    • invoiceDateDayOfMonth
    • targetDateMonthOffset
    • targetDateDayOfMonth
    • schedule > monthlyOnEndOfMonth
• Credit Memos - In the request body of the "Create a credit memo from a charge" operation, added the number field.
• Debit Memos - In the request body of the "Create a debit memo from a charge" operation, added the number field.

Doc updates

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

• In the "Object Queries" section, made the following updates:
  • Corrected the maximum value of the pageSize query parameter to 99 from 50.
  • Added 10 as the default value for the pageSize query parameter.
  • In the description of this section, added a limitation to clarify that filtering on unindexed fields is not supported.
  • In the description of the "List custom objects" operation, added a note to clarify that sorting custom objects by ID is not supported.
• Updated the "Base URL" section to add information about upcoming environments.

April 18, 2024

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: Update a product rate plan charge" operation, updated the description of each of the following fields to include the WSDL version information:
  • RevenueRecognitionTiming
  • RevenueAmortizationMethod
• In the "Update an account" operation, corrected the following nested fields in the ​​soldToContact and billToContact fields to non-required:
  • firstName
  • lastName
• In the request body of the "Create a billing preview run" operation, updated the description of the storageOption parameter.
• Renamed the "Access to the API" section to "Base URL", and updated the base URL table for better clarity.

April 12, 2024

API updates

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

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

• Accounts - Made the following updates:
  • Added the following operations:
    • Configure cascading payment methods for an account
    • Retrieve configuration of cascading payment methods for an account
  • In the response body of the "Retrieve an account" operation, added the billingAndPayment > paymentMethodCascadingConsent nested field.
  • In the response body of the "Retrieve an account summary" operation, added the basicInfo > paymentMethodCascadingConsent nested field.
• E-Invoicing - Made the following updates:
  • In the request body of each of the following operations, added the responseMapping field.
    • Create an e-invoicing business region
    • Update an e-invoicing business region
  • In the 200 response body of each of the following operations, added the responseMapping field:
    • Create an e-invoicing business region
    • Retrieve an e-invoicing business region
    • Update an e-invoicing business region
  • In the 200 response body of the "List e-invoicing business regions" operation, added the responseMapping nested field to the regions field.

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, added the missing excludeItemBillingFromRevenueAccounting nested field to the charges field:
  • Create a debit memo from a charge
  • Create a credit memo from a charge
• In the request body of each of the following operations:
  • Preview an order
  • Preview an order asynchronously
  • Create an order
  • Create an order asynchronously
  • Update an order

  Updated the description of each of the following fields for better clarity:

  • subscriptions > orderActions > addProduct > chargeOverrides > billing > billingPeriod
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > billing > billingPeriod
  • createSubscription > subscribeToRatePlans > chargeOverrides > billing > billingPeriod
• In the response body of each of the following operations:
  • List orders
  • List orders of a subscription owner
  • List orders by subscription number
  • List orders of an invoice owner

  Updated the description of each of the following fields for better clarity:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > billing > billingPeriod
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > billing > billingPeriod
  • orders > createSubscription > subscribeToRatePlans > chargeOverrides > billing > billingPeriod
• In the response body of the "Retrieve an order" operation, updated the description of each of the following fields for better clarity:
  • order > subscriptions > orderActions > addProduct > chargeOverrides > billing > billingPeriod
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > billing > billingPeriod
  • order > createSubscription > subscribeToRatePlans > chargeOverrides > billing > billingPeriod
• Updated the description of the "Data Labeling" section for better clarity.
• Updated the description of the "List all settings" operation to remove the deprecated settings for custom fields.
• Renamed the "Generate bulk PDF files" operation to "Export bulk PDF files".
• Updated the description of the "Export bulk PDF files" to add a reference to an FAQ article in the Knowledge Center.

The following update applies to the Older API Reference:

• In the request body of the "Amend" action, added the missing requests > Amendments > RatePlanData > RatePlan > AmendmentSubscriptionRatePlanId field.

April 5, 2024

API updates

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

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

API updates for Delivery-based Billing feature

The following items are the API updates specific to the General Availability announcement of the Delivery-based Billing feature.

• Subscriptions - Made the following updates:
  • In the response body of the "List subscriptions by account key" operation, removed the availability note in the description of the subscriptions > ratePlans > ratePlanCharges > numberOfDeliveries field.
  • In the response body of each of the following operations, removed the availability note in the description of the ratePlans > ratePlanCharges > numberOfDeliveries field:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
• Orders - Removed the availability note in each of the recurringDelivery and recurringDeliveryBased fields. The following operations are affected:
  • Preview an order
  • Preview an order asynchronously
  • Create an order
  • Create an order asynchronously
  • Update an order
  • List orders
  • Retrieve an order
  • List orders of a subscription owner
  • List orders by subscription number
  • List orders of an invoice owner
  • List pending orders by subscription number

API updates for E-Invoicing feature

The following items are the API updates specific to the E-Invoicing feature.

• E-Invoicing - Made the following updates:
  • In the request body of each of the following operations:
    • Create an e-invoicing service provider
    • Update an e-invoicing service provider

    Added the following fields:

    • apiKey
    • secretKey
    • clientCertificate
    • clientCertificateType
    • clientCertificatePassword
  • In the response body of the "Retrieve an e-invoicing service provider" operation, added the following fields:
    • apiKey
    • clientCertificate
    • clientCertificateType
  • In the response body of the "List e-invoice service providers" operation, added the following nested fields to the serviceProviders field:
    • apiKey
    • clientCertificate
    • clientCertificateType

Other API updates

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

• Notifications - Made the following updates:
  • In the request body of the "Create or update email templates" operation, added the emailHeaders field to the emailTemplates field.
  • In the request body of each of the following operations, added the emailHeaders field:
    • Create an email template
    • Update an email template
  • In the 200 response body of each of the following operations, added the emailHeaders field:
    • Create an email template
    • Retrieve an email template
    • Update an email template
  • In the 200 response body of the "List email templates" operation, added the emailHeaders field to the data field.
• Data Queries - In the "List data query jobs" operation, increased the number of records per page size in the pageSize query parameter from 100 to 1000.
• AQuA - Made the following updates:
  • In the request body of the "Submit an aggregate query job" operation, deprecated the following field and field value:
    • The warehouseSize field
    • The warehouse enum value for the sourceData field
  • In the response body of the "Submit an aggregate query job" operation, deprecated the warehouse value for the sourceData field.

March 28, 2024

API updates

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

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

• Object Queries - Added an "Object Queries" section that contains standardized GET methods to query Billing and Payments objects. For more information about Object Queries, see 2024.04.R1 Release Notes .
• Orders - Made the following updates to support the Tiered Pricing charge model for the Standalone Orders feature:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order

    Added the Tiered enum value for each of the following fields:

    • subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
  • In the response body of each of the following operations:
    • 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

    Added the Tiered enum value for each of the following fields:

    • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
  • In the response body of the "Retrieve an order" operations, added the Tiered enum value for each of the following fields:
    • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
• Orders - In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order
  • Preview an order
  • Preview an order asynchronously

  Added the endDate nested field to the following fields:

  • subscriptions > orderActions > createSubscription > terms > initialTerm
  • subscriptions > orderActions > termsAndConditions > lastTerm
• Usage - Made the following updates to support the Negative Quantity Usage feature:
  • In the request body of each of the following operations, enhanced the Quantity field to support negative values:
    • CRUD: Create a usage record
    • CRUD: Update a usage record
  • In the response body of the "CRUD: Retrieve a usage record" operation, enhanced the the Quantity field to support negative values.
  • In the response body of the "Retrieve a usage record" operation, enhanced the usage > quantity field to support negative values.
  • In the response body of the "Retrieve usage rate detail for an invoice item" operation, enhanced the data > quantity field to support negative values.
• Billing Preview Run - In the request body of the "Create a billing preview run" operation, added the storeDifference and comparedBillingPreviewRunId fields to support comparing the current billing preview run result with a specified billing preview run result and storing the difference in the database.
• Credit Memos - In the description of the "Unpost a credit memo" operation, added information about preventing the unpost operation.
• Debit Memos - In the description of the "Unpost a debit memo" operation, added information about preventing the unpost operation.
• Payment Schedules - In the "Retrieve a payment schedule" operation, added the following fields to the response body and updated the corresponding sample values:
  • cancelledById
  • cancelledOn
  • cancelDate
• Data Labeling - In the request body of the "Submit a data labeling job" operation, updated the description of the following fields to support the use case of unlabeling objects:
  • orgIds
  • orgs

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:
  • Create an order
  • Create an order asynchronously
  • Update an order

  Added the missing DiscountFixedAmount and DiscountPercentage enum values for each of the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel

  Removed the incorrect DiscountFixedAmount and DiscountPercentage enum values from each of the following fields:

  • subscriptions > orderActions > addProduct > chargeOverrides > chargeType
  • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
  • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
• In the response body of each of the following operations:
  • 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

  Added the missing DiscountFixedAmount and DiscountPercentage enum values for each of the following fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel

  Removed the incorrect DiscountFixedAmount and DiscountPercentage enum values from each of the following fields:

  • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeType
  • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
  • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
• In the response body of the "Retrieve an order" operation:

  Added the missing DiscountFixedAmount and DiscountPercentage enum values for each of the following fields:

  • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel

  Removed the incorrect DiscountFixedAmount and DiscountPercentage enum values from each of the following fields:

  • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeType
  • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
  • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
• In the response body of the Retrieve usage rate detail for an invoice item operation, corrected the type and format of the data > quantity field.
• In the response body of the Retrieve a usage record operation, corrected the type and format of the usage > quantity field.
• In the description of the "List all settings" operation, added the Zuora Tax Engine section.
• In the request body of the "Create a standalone invoice" and "Create standalone invoices" operations, updated the description of the invoices > invoiceItems field for better clarity.
• Updated the description of the "Refund a payment with auto-unapplying" operation.
• Updated the description of the "Data Labeling" section for better clarity.

March 22, 2024

API updates

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

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

• Payment Methods - In the request body of the "Create a payment method" operation, added the following fields for the ACH payment method type:
  • tokens
  • bankAccountMaskNumber
• Accounts - In the request body of the "Create an account" operation, added the following fields for the ACH payment method type:
  • paymentMethod > tokens
  • paymentMethod > bankAccountMaskNumber
• Orders - In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously

  Added the following fields for the ACH payment method type:

  • newAccount > paymentMethod > tokens
  • newAccount > paymentMethod > bankAccountMaskNumber

Doc updates

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

• In the request body of the "Generate bulk PDF files" operation, added enum values for the docType field.
• Updated the description of each of the following operations for better clarity:
  • Create an order
  • Update an order
  • Cancel an order
• In the request body of each of the following operations, updated the descriptions of the status and schedulingOptions fields for better clarity:
  • Create an order
  • Update an order
• In the response body of the "Retrieve an order" operation, updated the descriptions of the status and schedulingOptions nested fields of the order field for better clarity.
• In the response body of each of the following operations, updated the descriptions of the status and schedulingOptions nested fields of the orders field for better clarity:
  • List orders
  • List orders of a subscription owner
  • List orders by subscription number
  • List orders of an invoice owner
• For the following objects in all relevant operations, updated the description of the country field in the request body and response body for better clarity:
  • E-Invoicing Business Region
  • E-Invoice File Template
  • Payment Method
• In the "List e-invoice file templates" operation, updated the description of the country query parameter for better clarity.
• In the description of the "List payments" operation, added filtering condition information.
• In the request body and response body of the "Submit an aggregate query job" operation, corrected the data type of the offset field from number to integer.

March 15, 2024

API updates

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

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

API updates for E-Invoicing with PEPPOL

The following items are the API updates specific to the E-invoicing with PEPPOL feature.

• E-Invoicing - Made the following updates:
  • In the request body of the "Create an e-invoicing service provider" operation, added the PEPPOL enum value to the provider field.
  • In the 200 response body of each of the following operations, added the PEPPOL enum value to the provider field:
    • Create an e-invoicing service provider
    • Retrieve an e-invoicing service provider
    • Update an e-invoicing service provider
  • In the 200 response body of the "List e-invoicing service providers" operation, added the PEPPOL enum value to the serviceProviders > provider field.
• Invoices - In the 200 response body of the "Retrieve an invoice" operation, added the Generated enum value to the einvoiceStatus field.
• Credit Memos - Made the following updates:
  • In the 200 response body of each of the following operations, added the Generated enum value to the memos > einvoiceStatus field.
    • Create credit memos
    • Update credit memos
  • In the 200 response body of each of the following operations, added the Generated enum value to the einvoiceStatus field.
    • Create a credit memo from a charge
    • Create a credit memo from an invoice
    • Retrieve a credit memo
    • Update a credit memo
    • Apply a credit memo
    • Unapply a credit memo
    • Cancel a credit memo
    • Post a credit memo
    • Unpost a credit memo
  • In the 200 response body of the "List credit memos" operation, added the Generated enum value to the creditmemos > einvoiceStatus field.
• Debit Memos - Made the following updates:
  • In the 200 response body of each of the following operations, added the Generated enum value to the memos > einvoiceStatus field.
    • Create debit memos
    • Update debit memos
  • In the 200 response body of each of the following operations, added the Generated enum value to the einvoiceStatus field.
    • Create a debit memo from a charge
    • Create a debit memo from an invoice
    • Retrieve a debit memo
    • Update a debit memo
    • Cancel a debit memo
    • Post a debit memo
    • Unpost a debit memo
  • In the 200 response body of the "List debit memos" operation, added the Generated enum value to the debitmemos > einvoiceStatus field.

API updates for adding support for "Zuora custom event" event type in Notifications

The following items are the API updates specific to adding support for the "Zuora custom event" event type in the Events and Notifications feature.

• Notifications - Made the following updates:
  • Updated the description of each of the following operations:
    • Create a notification definition
    • List notification definitions
    • Retrieve a notification definition
    • Update a notification definition
    • Delete a notification definition
  • In the request body of the "Create a notification definition" operation, updated the description of each of the following fields:
    • eventTypeName
    • eventTypeNamespace
  • In the 200 response body of each of the following operations:
    • Create a notification definition
    • Retrieve a notification definition
    • Update a notification definition

    Updated the description of each of the following fields:

    • eventTypeName
    • eventTypeNamespace
  • For the "List notification definitions" operation, updated the description of the eventTypeName query parameter.
  • In the 200 response body of the "List notification definitions" operation, updated the description of each of the following fields:
    • data > eventTypeName
    • data > eventTypeNamespace

Other API updates

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

• Subscriptions - Made the following updates:
  • In the response body of each of the following operations:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version

    Added the following fields:

    • ratePlans > ratePlanCharges > upsellOriginChargeNumber
    • ratePlans > ratePlanCharges > chargeFunction
    • ratePlans > ratePlanCharges > commitmentType
  • In the response body of the "List subscriptions by account key" operation, added the following fields:
    • subscriptions > ratePlans > ratePlanCharges > upsellOriginChargeNumber
    • subscriptions > ratePlans > ratePlanCharges > chargeFunction
    • subscriptions > ratePlans > ratePlanCharges > commitmentType
• Orders - Made the following updates:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order
    • Preview an order
    • Preview an order asynchronously

    Added the following fields:

    • subscriptions > orderActions > addProduct > chargeOverrides > upsellOriginChargeNumber
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > upsellOriginChargeNumber
    • orderLineItems > currency
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • orders > subscriptions > orderActions > addProduct > chargeOverrides > upsellOriginChargeNumber
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > upsellOriginChargeNumber
    • orders > orderLineItems > currency
  • In the response body of the "Retrieve an order" operations, added the following fields:
    • order > subscriptions > orderActions > addProduct > chargeOverrides > upsellOriginChargeNumber
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > upsellOriginChargeNumber
    • order > orderLineItems > currency
  • In the request body of the "Update an order" operation, deprecated the newAccount field.
• Order Line Items - Made the following updates:
  • In the response body of each of the following operations, added the orderLineItem > currency field:
    • Retrieve an order line item
    • Update order line items
• Product Rate Plan Charges - Made the following updates:
  • In the request body of each of the following operations:
    • CRUD: Create a product rate plan charge
    • CRUD: Update a product rate plan charge

    Added the following fields:

    • ChargeFunction
    • CommitmentType
  • In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, added the following fields:
    • ChargeFunction
    • CommitmentType
  • In the 200 response body of the "Retrieve a product rate plan charge" operation, added the following fields:
    • chargeFunction
    • commitmentType
• Regenerate - In each of the following operations, added the onlyReSend query parameter:
  • Regenerate booking transactions
  • Regenerate billing transactions
• Orders - Made the following updates:
  • In the request body of each of the following operations:
    • Preview an order
    • Preview an order asynchronously
    • Create an order
    • Create an order asynchronously

    Added the subscriptionRatePlanNumber field to the following nested fields:

    • subscriptions > addProduct
    • subscriptions > createSubscription > subscribeToRatePlans
    • subscriptions > changePlan
  • In the response body of the "Preview an order" operation, added the subscriptionRatePlanNumber field to the following nested fields:
    • previewResult > chargeMetrics > charges
    • previewResult > orderMetrics > orderActions > orderMetrics
• Credit Memos - Added an operation called "List all files of a credit memo".
• Debit Memos - Added an operation called "List all files of a debit memo".
• Operations - Added the following operations:
  • Generate bulk PDF files
  • Retrieve information of a bulk PDF file generation job
• Invoices - Updated the description of the "List all application parts of an invoice" operation.

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 operations for better clarity:
  • Create an order
  • Update an order
  • Cancel an order
• In the request body of each of the following operations, updated the descriptions of the status and schedulingOptions fields for better clarity:
  • Create an order
  • Update an order
• In the response body of the "Retrieve an order" operation, updated the descriptions of the status and schedulingOptions nested fields of the order field for better clarity.
• In the response body of each of the following operations, updated the descriptions of the status and schedulingOptions nested fields of the orders field for better clarity:
  • List orders
  • List orders of a subscription owner
  • List orders by subscription number
  • List orders of an invoice owner
• In the response body of the "Create an order" operation, corrected the data format for each of the following fields:
  • orderLineItems > id
  • orderLineItems > itemNumber
• In each of the following operations, updated the description of the reMigrate query parameter:
  • Regenerate booking transactions
  • Regenerate billing transactions
• In the request body of the "Create an account" operation, updated the description of each of the following fields for better clarity:
  • paymentMethod > tokenize for the Bacs payment method type
  • paymentMethod > processingOptions > checkDuplicated for the CreditCard payment method type
• In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously

  Updated the description of each of the following fields for better clarity:

  • newAccount > paymentMethod > tokenize for the Bacs payment method type
  • newAccount > paymentMethod > processingOptions > checkDuplicated for the CreditCard payment method type
• In the request body of the "Create a payment method" operation, updated the description of each of the following fields for better clarity:
  • tokenize for the Bacs payment method type
  • processingOptions > checkDuplicated for the CreditCard payment method type
• Updated the description of each of the following operations for better clarity:
  • Create custom object records
  • Update a custom object record
  • Partially update a custom object record
  • Update or delete custom object records

March 7, 2024

API updates

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

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

• Subscriptions - Added a new operation called "Preview a subscription by subscription key".

March 1, 2024

API updates

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

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

API updates for passing identity number when creating Credit Card payment method

The following items are the API updates specific to a system behavior change introduced by the support of passing the identity number in the creation of a Credit Card payment method.

• Payment Methods - Made the following updates:
  • In the request body of the "Create a payment method" operation, added the identityNumber field for the CreditCard payment method type.
  • In the response body of the "Retrieve a payment method" operation, updated the description of the identityNumber nested field.
• Accounts - Made the following updates:
  • In the request body of the "Create an account" operation, added the paymentMethod > identityNumber nested field for the CreditCard payment method type.
  • In the response body of the "List payment methods of an account" operation, updated the description of the returnedPaymentMethodType > identityNumber nested field.
  • In the response body of the "Retrieve the default payment method of an account" operation, updated the description of the identityNumber nested field.
• Orders - In the request body of each of the following operations, added the newAccount > paymentMethod > identityNumber nested field for the CreditCard payment method type:
  • Create an order
  • Create an order asynchronously

API updates on currency field in response of billing document operations

• Billing Documents - In the response body of the "List billing documents for an account" operation, added the currency field.
• Invoices - In the response body of the "Retrieve an invoice" operation, updated the description of the currency field.
• Credit Memos - Made the following updates:
  • In the response body of the "Retrieve a credit memo" operation, updated the description of the currency field.
  • In the response body of the "List credit memos" operation, updated the description of the creditmemos > currency field.
• Debit Memos - Made the following updates:
  • In the response body of the "Retrieve a debit memo" operation, updated the description of the currency field.
  • In the response body of the "List debit memos" operation, updated the description of the debitmemos > currency field.

Other API updates

• Regenerate - Made the following updates:
  • Updated the API endpoint for each of the following operations:
    • Regenerate revenue recognition events transactions for Delivery Schedule
    • Regenerate revenue recognition events transactions for Daily Consumption
  • In each of the following operations, added a query parameter called forRevenueRecollect :
    • Regenerate revenue recognition events transactions for Delivery Schedule
    • Regenerate revenue recognition events transactions for Daily Consumption
• Orders - Made the following updates:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order
    • Preview an order
    • Preview an order asynchronously

    Added the following fields:

    • subscriptions > orderActions > removeProduct > customFields
    • subscriptions > orderActions > removeProduct > chargeUpdates
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • orders > subscriptions > orderActions > removeProduct > customFields
    • orders > subscriptions > orderActions > removeProduct > chargeUpdates
  • In the response body of the "Retrieve an order" operations, added the following fields:
    • order > subscriptions > orderActions > removeProduct > customFields
    • order > subscriptions > orderActions > removeProduct > chargeUpdates

Doc updates

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

• In the response body of the "List all items of an invoice" operation, added the missing applicableTaxUnRounded and country nested fields to the taxationItems field.
• For each of the following settings in the Settings API, corrected the templateFileName field from required to optional:
  • AllCreditMemoTemplates
  • AllDebitMemoTemplates

February 23, 2024

API updates

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

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

• Payments - For the "Refund a payment with auto-unapplying" operation, made the following updates:
  • In the request body, removed the availability note for each of the following fields because these fields are now generally available:
    • writeOff
    • writeOffOptions
  • In the response body, removed the availability note for the writeOffResults field because this field is now generally available.

Doc updates

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

• In the request body of the "Update a payment schedule item" operation, corrected the data type and the correspnding sample value for each of the following fields:
  • linkPayments
  • unlinkPayments
• In the response body of the "Invoice and collect" operation, made the following updates:
  • Corrected the creditMemos > memoAmount field to the creditMemos > totalAmount field.
  • Corrected the data type of the amountCollected field from string to number.
• In the request body of each of the following operations, introduced a filtering mechanism for the  type  field within the payment method object, to show only the relevant fields for the selected payment method type:
  • Create a payment method
  • Create an order
  • Create an order asynchronously
  • Update an order
• In the request body of the "Generate an RSA signature" operation, corrected the value for the US Cloud 1 Sandbox environment in the uri field.

The following update applies to the Older API Reference:

• In the request body of the "Amend" action, updated the description of the Amendments > BookingDate field for better clarity.

February 8, 2024

API updates

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

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

• Data Backfill - Added a section called "Data Backfill" that contains the following operations:
  • Create a booking date backfill job
  • List all booking date backfill jobs
  • Retrieve a booking date backfill job
  • Stop a booking date backfill job
  • Create a data backfill job
  • Retrieve a data backfill job
  • Stop a data backfill job
  • List all data backfill jobs
  • Download a data backfill template file
• Prepaid with Drawdown - Added an operation called "Deplete funds".
• Orders - Made the following updates:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order
    • Preview an order
    • Preview an order asynchronously

    Added the following fields:

    • orderLineItems > RevenueAmortizationMethod
    • orderLineItems > RevenueRecognitionTiming
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • orders > orderLineItems > RevenueAmortizationMethod
    • orders > orderLineItems > RevenueRecognitionTiming
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > revenueAmortizationMethod
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > revenueRecognitionTiming
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > revenueAmortizationMethod
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > revenueRecognitionTiming
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > revenueAmortizationMethod
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > revenueRecognitionTiming
  • In the response body of the "Retrieve an order" operations, added the following fields:
    • order > orderLineItems > RevenueAmortizationMethod
    • order > orderLineItems > RevenueRecognitionTiming
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > revenueAmortizationMethod
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > revenueRecognitionTiming
    • order > subscriptions > orderActions > addProduct > chargeOverrides > revenueAmortizationMethod
    • order > subscriptions > orderActions > addProduct > chargeOverrides > revenueRecognitionTiming
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > revenueAmortizationMethod
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > revenueRecognitionTiming
• Order Line Items - Made the following updates:
  • In the request body of the "Update an order line item" operation, added the revenueAmortizationMethod and revenueRecognitionTiming fields.
  • In the request body of the "Update order line items" operation, added the revenueAmortizationMethod and revenueRecognitionTiming nested fields to the orderLineItems field.
  • In the response body of each of the following operations, added the revenueAmortizationMethod and revenueRecognitionTiming nested fields to the orderLineItem field:
    • Retrieve an order line item
    • Update order line items
• Subscriptions - Made the following updates:
  • In the response body of each of the following operations:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version

    Added the following fields:

    • ratePlans > ratePlanCharges > revenueAmortizationMethod
    • ratePlans > ratePlanCharges > revenueRecognitionTiming
  • In the response body of the "List subscriptions by account key" operation, added the following fields:
    • subscriptions > ratePlans > ratePlanCharges > revenueAmortizationMethod
    • subscriptions > ratePlans > ratePlanCharges > revenueRecognitionTiming

Doc updates

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

• In the response body of the "Update order line items" operation, adding the missing excludeItemBillingFromRevenueAccounting and excludeItemBookingFromRevenueAccounting nested fields to the orderLineItems field.
• In the source YAML file, made the following updates to avoid confusion:
  • Renamed the CommonResponseType schema to CommonResponse .
  • Removed the redundant CommonErrorResponse schema.
  • Updated each reference to the CommonErrorResponse or CommonResponseType schema to be referencing CommonResponse .

February 2, 2024

API updates

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

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

API updates for duplication check on payment methods

The following items are the API updates specific to a system behavior change for duplication check on payment methods.

• Payment Methods - Made the following updates:
  • In the request body of each of the following operations, added the processingOptions field and its nested field:
    • Create a payment method
    • Update a payment method
  • In the request body of the "Create a payment method" operation, updated the description of the checkDuplicated field.
• Accounts - In the request body of the "Create an account" operation, made the following updates:
  • Added the processingOptions field and its nested field to the paymentMethod field.
  • Updated the description of the paymentMethod > checkDuplicated nested field.
• Orders - In the request body of each of the following operations:
  • Create an order
  • Create an order asynchronously
  • Update an order

  Made the following updates:

  • Added the processingOptions field and its nested field to the newAccount > paymentMethod field.
  • Updated the description of the newAccount > paymentMethod > checkDuplicated nested field.

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:
  • Create a notification definition
  • Update a notification definition

  Reorganized the nested fields of the callout field according to the following scenarios:

  • Without authentication
  • Base authentication
  • OAuth 2.0 authentication

January 26, 2024

API updates

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

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

API updates for the Invoice Grouping feature

The following items are the API updates specific to the Invoice Grouping feature.

• Credit Memos - Made the following updates:
  • In the response body of each of the following operations, added the invoiceGroupNumber field:
    • Create a credit memo from a charge
    • Create a credit memo from an invoice
    • Retrieve a credit memo
    • Update a credit memo
    • Apply a credit memo
    • Unapply a credit memo
    • Cancel a credit memo
    • Post a credit memo
    • Unpost a credit memo
  • In the response body of each of the following operations, added the invoiceGroupNumber nested field to the memos field:
    • Create credit memos
    • Update credit memos
  • In the response body of the "List credit memos" operation, added the invoiceGroupNumber nested field to the creditmemos field.
• Debit Memos - Made the following updates:
  • In the response body of each of the following operations, added the invoiceGroupNumber field:
    • Create a debit memo from a charge
    • Create a debit memo from an invoice
    • Retrieve a debit memo
    • Update a debit memo
    • Cancel a debit memo
    • Post a debit memo
    • Unpost a debit memo
  • In the response body of each of the following operations, added the invoiceGroupNumber nested field to the memos field:
    • Create debit memos
    • Update debit memos
  • In the response body of the "List debit memos" operation, added the invoiceGroupNumber nested field to the debitmemos field.
• Invoices - Made the following updates:
  • In the response body of each of the following operations, added the invoiceGroupNumber field:
    • Retrieve an invoice
    • Create a standalone invoice
  • In the response body of the "Create standalone invoices" operation, added the invoiceGroupNumber nested field to the invoices field.
• Orders - Made the following changes:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order
    • Preview an order
    • Preview an order asynchronously

    Added the following fields:

    • orderLineItems > invoiceGroupNumber
    • subscriptions > orderActions > createSubscription > invoiceGroupNumber
    • subscriptions > orderActions > ownerTransfer > invoiceGroupNumber
    • subscriptions > orderActions > ownerTransfer > clearingExistingInvoiceGroupNumber
    • subscriptions > orderActions > renewSubscription > invoiceGroupNumber
    • subscriptions > orderActions > renewSubscription > clearingExistingInvoiceGroupNumber
    • subscriptions > orderActions > termsAndConditions > invoiceGroupNumber
    • subscriptions > orderActions > termsAndConditions > clearingExistingInvoiceGroupNumber
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • orders > orderLineItems > invoiceGroupNumber
    • orders > subscriptions > orderActions > createSubscription > invoiceGroupNumber
    • orders > subscriptions > orderActions > ownerTransfer > invoiceGroupNumber
    • orders > subscriptions > orderActions > ownerTransfer > clearingExistingInvoiceGroupNumber
    • orders > subscriptions > orderActions > renewSubscription > invoiceGroupNumber
    • orders > subscriptions > orderActions > renewSubscription > clearingExistingInvoiceGroupNumber
    • orders > subscriptions > orderActions > termsAndConditions > invoiceGroupNumber
    • orders > subscriptions > orderActions > termsAndConditions > clearingExistingInvoiceGroupNumber
  • In the response body of the "Retrieve an order" operations, added the following fields:
    • order > orderLineItems > invoiceGroupNumber
    • order > subscriptions > orderActions > createSubscription > invoiceGroupNumber
    • order > subscriptions > orderActions > ownerTransfer > invoiceGroupNumber
    • order > subscriptions > orderActions > ownerTransfer > clearingExistingInvoiceGroupNumber
    • order > subscriptions > orderActions > renewSubscription > invoiceGroupNumber
    • order > subscriptions > orderActions > renewSubscription > clearingExistingInvoiceGroupNumber
    • order > subscriptions > orderActions > termsAndConditions > invoiceGroupNumber
    • order > subscriptions > orderActions > termsAndConditions > clearingExistingInvoiceGroupNumber
• Order Line Items - Made the following updates:
  • In the request body of the "Update an order line item" operation, added the invoiceGroupNumber field.
  • In the request body of the "Update order line items" operation, added the invoiceGroupNumber nested field to the orderLineItems field.
  • In the response body of each of the following operations, added the invoiceGroupNumber nested field to the orderLineItem field:
    • Retrieve an order line item
    • Update order line items
• Subscriptions - Made the following updates:
  • In the response body of each of the following operations, added the invoiceGroupNumber field:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
  • In the response body of the "List subscriptions by account key" operation, added the invoiceGroupNumber nested field to the subscriptions field.

Other API updates

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

• Notifications - Made the following updates:
  • In the request body of each of the following operations:
    • Create an email template
    • Update an email template

    Updated the description of each of the following fields to clarify that merge fields enclosed by double curly brackets are supported now.

    • emailBody
    • emailSubject
  • In the request body of the "Create or update email templates" operation, updated the description of each of the following fields to clarify that merge fields enclosed by double curly brackets are supported now.
    • emailTemplates > emailBody
    • emailTemplates > emailSubject
  • In the 200 response body of each of the following operations:
    • Create an email template
    • Update an email template
    • Retrieve an email template

    Updated the description of each of the following fields to clarify that merge fields enclosed by double curly brackets are supported now.

    • emailBody
    • emailSubject
  • In the 200 response body of the "List email templates" operation, updated the description of each of the following fields to clarify that merge fields enclosed by double curly brackets are supported now.
    • data > emailBody
    • data > emailSubject

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 associatedAccount field for better clarity.
  • Create a notification definition
  • Update a notification definition
• In the 200 response body of each of the following operations, updated the description of the associatedAccount field for better clarity.
  • Create a notification definition
  • Retrieve a notification definition
  • Update a notification definition
• In the 200 response body of the "List notification definitions" operation, updated the description of the data > associatedAccount field for better clarity.

January 19, 2024

API updates

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

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

• Invoices - Added an operation called "Retrieve the PDF file generation status of invoices".
• Credit Memos - Added an operation called "Retrieve the PDF file generation status of credit memos".
• Debit Memos - Added an operation called "Retrieve the PDF file generation status of debit memos".
• Orders - Made the following changes:
  • In the response body of each of the following operations, added the scheduledOrderActivationResponse 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
  • In the response body of the "Retrieve an order" operation, added the scheduledOrderActivationResponse nested field to the order field.
• Payment Gateway Reconciliation - Updated the description of each of the following operations for system behavior changes introduced by a Gateway Reconciliation enhancement:
  • Reject a payment
  • Reverse a payment
• Notifications - Made the following changes:
  • Updated the description of each of the following operations for supporting notification definitions for standard events:
    • Create a notification definition
    • List notification definitions
    • Retrieve a notification definition
    • Update a notification definition
    • Delete a notification definition
  • In the request body of the "Create a notification definition" operation, made the following updates:
    • Added the eventCategory field.
    • Updated the description of each of the following fields for better clarity:
      • eventTypeName
      • eventTypeNamespace
  • In the 200 response body of each of the following operations:
    • Create a notification definition
    • Retrieve a notification definition
    • Update a notification definition

    Made the following updates:

    • Added the following fields:
      • eventCategory
      • eventId
    • Updated the description of each of the following fields for better clarity:
      • eventTypeName
      • eventTypeNamespace
  • For the "List notification definitions" operation, made the following updates:
    • Added a query parameter called eventCategory that accepts the event category codes for standard events.
    • Updated the description of the eventTypeName query parameter for better clarity.
  • In the 200 response body of the "List notification definitions" operation, made the following updates:
    • Added the following fields:
      • data > eventCategory
      • data > eventId
    • Updated the description of each of the following fields for better clarity:
      • data > eventTypeName
      • data > eventTypeNameSpace
• E-Invoicing - Made the following updates:
  • In the request body of each of the "Create an e-invoicing service provider" and "Update an e-invoicing service provider" operations:
    • Added the companyIdentifier field.
    • Removed the apiKey and secretKey fields.
  • In the 200 response body of each of the following operations, added the companyIdentifier field and removed the apiKey field:
    • Create an e-invoicing service provider
    • Retrieve an e-invoicing service provider
    • Update an e-invoicing service provider
  • In the 200 response body of the "List e-invoicing service providers" operation, made the following updtes:
    • Added the companyIdentifier nested field to the serviceProviders field.
    • Removed the apiKey nested field from the serviceProviders field.

Doc updates

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

Doc updates for the Delivery Adjustments feature

The following items are the documentation updates specific to the Delivery Adjustments feature.

• In the request body of each of the following operations:
  • Create a delivery adjustment
  • Preview a delivery adjustment

  Updated the description of each of the following fields for better clarity:

  • deferredRevenueAccountingCode
  • recognizedRevenueAccountingCode
  • revenueRecognitionRuleName
• In the response body of each of the following operations:
  • Create a delivery adjustment
  • Preview a delivery adjustment

  Updated the description of each of the following fields for better clarity:

  • adjustments > deferredRevenueAccountingCode
  • adjustments > recognizedRevenueAccountingCode
  • adjustments > revenueRecognitionRuleName
  • ineligibleAdjustments > deferredRevenueAccountingCode
  • ineligibleAdjustments > recognizedRevenueAccountingCode
  • ineligibleAdjustments > revenueRecognitionRuleName
• In the response body of the "List all delivery adjustments of a subscription" operation, updated the description of each of the following fields for better clarity:
  • adjustments > deferredRevenueAccountingCode
  • adjustments > recognizedRevenueAccountingCode
  • adjustments > revenueRecognitionRuleName
• In the response body of the "Retrieve a delivery adjustment" operation, updated the description of each of the following fields for better clarity:
  • deferredRevenueAccountingCode
  • recognizedRevenueAccountingCode
  • revenueRecognitionRuleName

Other doc updates

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

• In the description of the "Create an event trigger" operation, added the missing base objects.
• In the request body of each of the following operations, added the missing Formula field.
  • CRUD: Create a product rate plan charge
  • CRUD: Update a product rate plan charge
• In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, added the missing Formula field.
• In the 200 response body of the "Retrieve a product rate plan charge" operation, added the following missing fields.
  • formula
  • applyToBillingPeriodPartially
  • isPrepaid
  • prepaidOperationType
  • prepaidQuantity
  • prepaidTotalQuantity
  • prepaidUom
  • validityPeriodType
  • drawdownRate
  • drawdownUom
  • creditOption
  • isRollover
  • rolloverApply
  • rolloverPeriodLength
  • rolloverPeriods
• In the 200 reponse body of the "CRUD: Retrieve a product rate plan charge" operation and the request body of each of the following operations:
  • CRUD: Create a product rate plan charge
  • CRUD: Update a product rate plan charge

  Updated the description for each of the following fields to indicate the requirement of the X-Zuora-WSDL-Version request header:

  • IsAllocationEligible
  • IsUnbilled
  • ProductCategory
  • ProductClass
  • ProductFamily
  • ProductLine
• In the request body of the "Create a payment" operation, updated the description of the type field.
• In the request body of the "Create credit memos" operation, updated the description of the memos > items > taxMode field to clarify that this field only needs to be included when the credit memo needs to be processed with a different tax mode.

January 11, 2024

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 a payment method" operation, updated the enum values of the bankAccountType field.
• In the response body of the "Retrieve a payment method" operation, updated the enum values of the bankAccountType field.
• In the response body of the "List custom exchange rates by currency" operation, corrected the data type for the rates field.

January 5, 2024

API updates

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

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

API updates for Payment Gateway Routing

The following items are the API updates specific to a system behavior change introduced by the Payment Gateway Routing feature.

• Payments - In the request body of the "Create a payment" operation, updated the description of the gatewayId field.
• Orders - In the request body of the "Create an order" operation, updated the description of the nested processingOptions > electronicPaymentOptions > paymentGatewayId field.
• Subscriptions - In the request body of the "Create a subscription" operation, updated the description of the gatewayId field.
• Payment Runs - In the request body of the "Create a payment run" operation, updated the description of the nested data > paymentGatewayId field.

Other API updates

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

• Payment Methods - In the request body of the "Create a payment method" operation, updated the description of the tokenize field for the newly supported BACS payment methods on Adyen Integration v2.0.
• Accounts - Made the following updates:
  • In the request body of each of the following operations, added the businessCategory nested field to the einvoiceProfile field:
    • Create an account
    • Update an account
  • In the response body of the "Retrieve an account" operation, added the businessCategory nested field to the einvoiceProfile field.

Doc updates

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

• In the response body of the "Retrieve an invoice" operation, added the missing success field.
• From the response body of the "List all items of an invoice" operation, made the following updates:
  • Added the following missing nested fields to the invoiceItems field:
    • fulfillmentId
    • orderLineItemId
  • Removed the unsupported success nested field from the invoiceItems field.
• Updated the request examples of the "Update a payment schedule item" operation.
• In the "Create a payment" operation, made the following updates:
  • Updated the description of this operation for the Multiple Currencies feature.
  • In the request body, updated the desciption of each of the following fields:
    • currency
    • effectiveDate
• In the request body of the "Create a payment run" operation, updated the description of each of the following fields:
  • data
  • data > dataItems

January 3, 2024

API updates

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

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

• Product Rate Plan Charges - Made the following updates:
  • In the request body of each of the following operations:
    • CRUD: Create a product rate plan charge
    • CRUD: Update a product rate plan charge

    Added the following fields:

    • RevenueRecognitionTiming
    • RevenueAmortizationMethod
  • In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, added the following fields:
    • RevenueRecognitionTiming
    • RevenueAmortizationMethod
  • In the 200 response body of the "Retrieve a product rate plan charge" operation, added the following fields:
    • revenueRecognitionTiming
    • revenueAmortizationMethod
• Product Charge Definitions - Made the following updates:
  • In the 200 response body of each of the "List product charge definitions" and "Update product charge definitions" operations, added the following fields:
    • chargeDefinitions > revenueRecognitionTiming
    • chargeDefinitions > revenueAmortizationMethod
  • In the 200 response body of each of the "Retrieve a product charge definition" and "Update a product charge definition" operations, added the revenueRecognitionTiming and revenueAmortizationMethod fields.

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:
  • Create a product charge definition
  • Update a product charge definition

  Removed the following fields:

  • excludeItemBillingFromRevenueAccounting
  • excludeItemBookingFromRevenueAccounting
  • isAllocationEligible
  • isUnbilled
  • productCategory
  • productClass
  • productFamily
  • productLine
• In the request body of each of the following operations:
  • Create product charge definitions
  • Update product charge definitions

  Removed the following fields:

  • productChargeDefinitions > excludeItemBillingFromRevenueAccounting
  • productChargeDefinitions > excludeItemBookingFromRevenueAccounting
  • productChargeDefinitions > isAllocationEligible
  • productChargeDefinitions > isUnbilled
  • productChargeDefinitions > productCategory
  • productChargeDefinitions > productClass
  • productChargeDefinitions > productFamily
  • productChargeDefinitions > productLine
• We have reverted API documentation updates about the Gateway Reconciliation enhancements published on December 22, 2023. These changes will be delivered in an upcoming release.

December 22, 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 2024.01.R1. For release notes for all Zuora products, see Latest releases.

API updates for the Billing Schedule feature

The following items are the API updates specific to the General Availability announcement of the Billing Schedule feature.

• Invoice Schedules - In the description of each of the following operations, changed the Early Adopter note to the General Availability note for the Billing Schedule feature:
  • Create an invoice schedule
  • Retrieve an invoice schedule
  • Update an invoice schedule
  • Execute an invoice schedule
  • Pause an invoice schedule
  • Resume an invoice schedule
  • Delete an invoice schedule
• Credit Memos - Made the following updates:
  • In the response body of the "Retrieve a credit memo item" operation, updated the availability note in the description of each of the following fields:
    • invoiceScheduleId
    • invoiceScheduleItemId
  • In the response body of the "List credit memo items" operation, updated the availability note in the description of each of the following fields:
    • items > invoiceScheduleId
    • items > invoiceScheduleItemId
• Invoices - In the response body of the "List all items of an invoice" operation, updated the availability note in the description of each of the following fields:
  • invoiceItems > invoiceScheduleId
  • invoiceItems > invoiceScheduleItemId
• Orders - Made the following updates:
  • In the response body of each of the following operations, updated the availability note in the description of the order > invoiceScheduleId field:
    • Retrieve an order
    • List order metrics for an evergreen subscription (in the Older API Reference)
  • In the response body of each of the following operations, updated the availability note in the description of the orders > invoiceScheduleId 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, updated the availability note in the description of each of the following fields:
    • subscriptions > invoiceScheduleId
    • subscriptions > ratePlans > ratePlanCharges > invoiceScheduleId
  • In the response body of each of the following operations, updated the availability note in the description of each of the invoiceScheduleId and ratePlans > ratePlanCharges > invoiceScheduleId fields:
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version

API updates for the Multiple Currencies feature

The following items are the API updates specific to the General Availability announcement of the Multiple Currencies feature.

• Accounts - In the response body of the "Retrieve an account" operation, updated the availability note in the description of each of the following fields:
  • metrics
  • metricsData
• Credit Memos - Made the following updates:
  • In the request body of the "Create a credit memo from a charge" operation, updated the availability note in the description of the currency field.
  • In the request body of the "Create credit memos" operation, updated the availability note in the description of the memos > currency field.
• Debit Memos - Made the following updates:
  • In the request body of the "Create a debit memo from a charge" operation, updated the availability note in the description of the currency field.
  • In the request body of the "Create debit memos" operation, updated the availability note in the description of the memos > currency field.
• Invoices - Made the following updates:
  • In the request body and response body of the "Create a standalone invoice" operation, updated the availability note in the description of the currency field.
  • In the request body and response body of the "Create standalone invoices" operation, updated the availability note in the description of the invoices > currency field.
  • In the response body of the "Retrieve an invoice" operation, updated the availability note in the description of the currency field.
• Invoice Schedules - In the response body of each of the following operations, updated the availability note in the description of the currency field:
  • Create an invoice schedule
  • Update an invoice schedule
  • Retrieve an invoice schedule
  • Pause an invoice schedule
  • Resume an invoice schedule
• Orders - Made the following updates:
  • In the request body of each of the following operations, updated the availability note in the description of the subscriptions > orderActions > createSubscription > currency field:
    • Create an order
    • Create an order asynchronously
    • Preview an order
    • Preview an order asynchronously
  • In the response body of the "Retrieve an order" operation, updated the availability note in the description of the order > subscriptions > orderActions > createSubscription > currency field.
  • In the response body of each of the following operations, updated the availability note in the description of the orders > subscriptions > orderActions > createSubscription > currency 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

The following updates apply to the Older API Reference:

• Orders - In the response body of the "List order metrics for an evergreen subscription" operation, updated the availability note in the description of the order > subscriptions > orderActions > createSubscription > currency field.
• Subscriptions - In the response body of the "CRUD: Retrieve a subscription" operation, updated the availability note in the description of the Currency field.

API updates for the E-Invoicing feature

The following items are the API updates specific to the the General Availability announcement of the E-Invoicing feature.

• E-Invoicing - Made the following updates:
  • In the request body of each of the following operations:
    • Create an e-invoicing business region
    • Update an e-invoicing business region

    Added the following fields:

    • digitalSignatureEnable
    • digitalSignatureBoxEnable
    • digitalSignatureBoxPosX
    • digitalSignatureBoxPosY
  • In the response body of each of the following operations:
    • Create an e-invoicing business region
    • Update an e-invoicing business region
    • Retrieve an e-invoicing business region

    Added the following fields:

    • digitalSignatureEnable
    • digitalSignatureBoxEnable
    • digitalSignatureBoxPosX
    • digitalSignatureBoxPosY
  • In the response body of the "List e-invoicing business regions" operation, added the following nested fields to the regions field:
    • digitalSignatureEnable
    • digitalSignatureBoxEnable
    • digitalSignatureBoxPosX
    • digitalSignatureBoxPosY

Other API updates

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

• Metadata - Added a section called "Metadata", containing the following operations:
  • Compare and deploy a source tenant to a target tenant
  • Compare and deploy a template to a tenant
  • Revert a deployment
  • Retrieve a deployment log
  • Compare and deploy the product catalog of a tenant to a target tenant
  • Compare and deploy a template for the product catalog to a tenant
• Workflows - Added the "Stop a workflow run" operation.
• Payment Gateway Reconciliation - Updated the description of each of the following operations for the Gateway Reconciliation enhancements:
  • Reject a payment
  • Reverse a payment
• Payments - In the request body of each of the following operations, added the refundTransactionType field:
  • Refund a payment
  • Refund a payment with auto-unapplying

Doc updates

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

• Removed the "Offers" and "Price Book Items" sections as well as all related fields in other corresponding operations for the Offers feature and the Price Book Item feature, which are superseded by the Attribute-based Pricing feature. When creating a subscription, you can only use the subscribeToRatePlans field to subscribe to a product rate plan because the subscribeToProducts field is removed.

December 15, 2023

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 operations for better clarity:
  • Create a draft custom payment method type
  • Update a custom payment method type
• In the response body of the "List all items of an invoice" operation, updated the description of the invoiceItems > balance field for better clarity.
• In the 200 response body of the "Retrieve a product rate plan charge" operation, added the following missing fields:
  • excludeItemBillingFromRevenueAccounting
  • excludeItemBookingFromRevenueAccounting
  • isAllocationEligible
  • isUnbilled
  • productCategory
  • productClass
  • productFamily
  • productLine
• In the 200 response body of the "CRUD: Retrieve a product rate plan charge" operation, added the following missing fields:
  • IsAllocationEligible
  • IsUnbilled
  • ProductCategory
  • ProductClass
  • ProductFamily
  • ProductLine
• In the request body of each of the following operations:
  • Create a product charge definition
  • Update a product charge definition

  Added the following missing fields:

  • excludeItemBillingFromRevenueAccounting
  • excludeItemBookingFromRevenueAccounting
  • isAllocationEligible
  • isUnbilled
  • productCategory
  • productClass
  • productFamily
  • productLine
• In the request body of each of the following operations:
  • Create product charge definitions
  • Update product charge definitions

  Added the following missing fields:

  • productChargeDefinitions > excludeItemBillingFromRevenueAccounting
  • productChargeDefinitions > excludeItemBookingFromRevenueAccounting
  • productChargeDefinitions > isAllocationEligible
  • productChargeDefinitions > isUnbilled
  • productChargeDefinitions > productCategory
  • productChargeDefinitions > productClass
  • productChargeDefinitions > productFamily
  • productChargeDefinitions > productLine
• In the 200 response body of the "Retrieve a product charge definition" operation, added the following missing fields:
  • excludeItemBillingFromRevenueAccounting
  • excludeItemBookingFromRevenueAccounting
  • isAllocationEligible
  • isUnbilled
  • productCategory
  • productClass
  • productFamily
  • productLine
• In the 200 response body of the "List product charge definitions" operation, added the following missing fields:
  • chargeDefinitions > excludeItemBillingFromRevenueAccounting
  • chargeDefinitions > excludeItemBookingFromRevenueAccounting
  • chargeDefinitions > isAllocationEligible
  • chargeDefinitions > isUnbilled
  • chargeDefinitions > productCategory
  • chargeDefinitions > productClass
  • chargeDefinitions > productFamily
  • chargeDefinitions > productLine
• In the 200 response body of "Retrieve a product rate plan charge" operation, corrected the enum values of the model field.
• Updated the description of the "Query" action for better clarity.

December 8, 2023

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 existingAccountNumber field for better clarity:
  • Preview an order
  • Preview an order asynchronously
  • Create an order
  • Create an order asynchronously
  • Update an order
• Updated the description of each of the following operations for better consistency:
  • Create authorization
  • Cancel authorization

December 1, 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.12.R1. For release notes for all Zuora products, see Latest releases.

• Settings - Made the following updates:
  • Added the following parameters to the BillingRules setting:
    • discountConsolidated
    • availableToCreditIncludingRbeCreditMemo
  • Added the jsonFields parameter to the following settings:
    • AllTaxEngines
    • CreateGlobalTaxHubTaxEngine
    • GlobalTaxHubTaxEngine

  See 200 response sample in JSON format.

• Orders - Made the following updates:
  • In the request body of the "Create an order" operation, added the following nested fields to the processingOptions > electronicPaymentOption field:
    • authTransactionId
    • gatewayOrderId
  • In the source YAML file, added the processingOptionsOrdersWithDelayedCapturePayment definition, and updated the schema reference of the processingOptions field in the request body of the "Create an order" operation to this definition.
• Payment Authorization - In the section description, added the "Create an order" operation as a supported operation for the Delayed Capture feature.

Doc updates

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

• For the "CRUD: Create usage record" operation, made the following updates:
  • Added the missing X-Zuora-WSDL-Version header parameter.
  • In the request body, added the missing UniqueKey field.
• Updated field descriptions for E-Invocing operations.

November 24, 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.12.R1. For release notes for all Zuora products, see Latest releases.

API updates for the Order to Revenue feature

The following items are the API updates specific to the Order to Revenue feature.

• Regenerate - Added a section called "Regenerate", containing the following operations:
  • Regenerate booking transactions
  • Regenerate billing transactions
  • Regenerate revenue recognition events transactions for Delivery Schedule
  • Regenerate revenue recognition events transactions for Daily Consumption

API updates for the Billing Schedule feature

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

• Invoice Schedules - Made the following updates:
  • In the request body of each of the following operations:
    • Create an invoice schedule
    • Update an invoice schedule

    Made the following updates:

    • Added the percentage nested field to the scheduleItems field.
    • Updated the description of the scheduleItems > amount field to clarify the incompatibility with the scheduleItems > percentage field.
    • Added the chargeNumbers nested field to the specificSubscriptions field.
  • In the response body of each of the following operations, added the percentage nested field to the scheduleItems field:
    • Create an invoice schedule
    • Update an invoice schedule
    • Retrieve an invoice schedule
    • Pause an invoice schedule
    • Resume an invoice schedule

    Made the following updates:

    • Added the percentage nested field to the scheduleItems field.
    • Added the chargeNumbers nested field to the specificSubscriptions field.

API updates for the Delivery Pricing charge model

The following items are the API updates specific to the Delivery Pricing charge model.

• Credit Memos - Made the following updates:
  • In the response body of the "Retrieve a credit memo item" operation, added the numberOfDeliveries field.
  • In the response body of the "List credit memo items" operation, added the numberOfDeliveries nested field to the items field.
• Invoices - In the response body of the "List all items of an invoice" operation, added the numberOfDeliveries nested field to the invoiceItems field.
• Operations - In the response body of the "Generate a billing preview" operation, added the following fields:
  • invoiceItems > numberOfDeliveries
  • creditMemoItems > numberOfDeliveries
• Orders - In the response body of the "Preview an order" operation, added the numberOfDeliveries nested field to each of the following fields:
  • previewResult > invoices > invoiceItems > additionalInfo
  • previewResult > creditMemos > creditMemoItems > additionalInfo

Other API updates

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

• Orders - Made the following changes:
  • In the request body of each of the following operations:
    • Preview an order
    • Preview an order asynchronously
    • Create an order
    • Create an order asynchronously
    • Update an order

    Added the following fields, and removed the requirement of enabling the Standalone Orders feature for using this field in other order actions:

    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageFlatFee > originalListPrice
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > updateProduct > ratePlanUpdates > chargeUpdates > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > updateProduct > ratePlanUpdates > chargeUpdates > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > updateProduct > ratePlanUpdates > chargeUpdates > pricing > usageFlatFee > originalListPrice
    • subscriptions > orderActions > updateProduct > ratePlanUpdates > chargeUpdates > pricing > usagePerUnit > originalListPrice
• Product Charge Definitions - Made the following updates to support the Discount - Fixed Amount and Discount Percentage charge models for the Attribute-based Pricing feature:
  • In the request body of each of the following operations:
    • Create a product charge definition
    • Update a product charge definition

    Made the following updates:

    • Added the DiscountFixedAmount and DiscountPercentage enum values for the chargeModel field.
    • Added the prices > discountAmount and prices > discountPercentage fields.
  • In the request body of each of the following operations:
    • Create product charge definitions
    • Update product charge definitions

    Made the following updates:

    • Added the DiscountFixedAmount and DiscountPercentage enum values for the productChargeDefinitions > chargeModel field.
    • Added the productChargeDefinitions > prices > discountAmount and productChargeDefinitions > prices > discountPercentage fields.

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 ID array for better clarity:
  • Resend email notifications
  • Resend callout notifications
• Updated the description of each of the following operations for better clarity:
  • Preview an order
  • Preview an order asynchronously
  • Create an order
  • Create an order asynchronously
• Removed the following operations:
  • List all credit memo part items
  • Retrieve a credit memo part item
• In the request body of the "Refund a payment with auto-unapplying" operation, added the availability note for the following fields:
  • writeOff
  • writeOffOptions
• In the response body of the "Refund a payment with auto-unapplying" operation, added the availability note for the writeOffResults field.
• In each of the following operations, updated the description of the product-rateplan-definition-key path parameter for better clarity:
  • Retrieve a product rate plan definition
  • Delete a product rate plan definition

November 17, 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.11.R2. For release notes for all Zuora products, see Latest releases.

• Product Charge Definitions - Added the following operations to create or update multiple product charge definitions in one request:
  • Create product charge definitions
  • Update product charge definitions

Doc updates

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

• In the 200 response body of the "List product charge definitions" operation, made the following updates:
  • Added the missing chargeDefinitions > isDefault field.
  • Corrected the field name for each of the following fields to comply with the actual API:
    • chargeDefinitions > productRatePlanChargeId
    • chargeDefinitions > productRatePlanChargeNumber
• In the 200 response body of each of the following operations:
  • Retrieve a product charge definition
  • Update a product charge definition

  Made the following updates:

  • Added the missing isDefault field.
  • Corrected the field name for each of the following fields to comply with the actual API:
    • productRatePlanChargeId
    • productRatePlanChargeNumber
• In the response body of the "List all product rate plans of a product" operation, corrected the Semi-Annual enum value to Semi_Annual for the productRatePlans > productRatePlanCharges > billingPeriod field.
• Updated the cURL request sample for each of the following operations:
  • List API volume summary records
  • List billing document volume summary records

November 10, 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.11.R1. For release notes for all Zuora products, see Latest releases.

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

    Added the following fields:

    • ratePlans > ratePlanCharges > isStackedDiscount
    • offers > ratePlans > ratePlanCharges > isStackedDiscount
  • In the response body of the "List subscriptions by account key" operation, added the following fields:
    • subscriptions > ratePlans > ratePlanCharges > isStackedDiscount
    • offers > ratePlans > ratePlanCharges > isStackedDiscount
• Orders - Made the following changes to add validation on the non-revenue data exclusion fields to fulfill the Order to Revenue feature's support for Advanced Consumption Billing :
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order

    Enhanced the behavior of each of the following fields:

    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • In the request body of each of the following operations:
    • Preview an order
    • Preview an order asynchronously

    Enhanced the behavior of each of the following fields:

    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • In the response body of each of the following operations:
    • 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

    Enhanced the behavior of each of the following fields:

    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • In the response body of the "Retrieve an order" operation, enhanced the behavior of each of the following fields:
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • order > subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • order > subscriptions > orderActions > addProduct > chargeOverrides > excludeItemBillingFromRevenueAccounting
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > excludeItemBillingFromRevenueAccounting
• Settings - Added the following parameters to the NumberAndSku setting:
  • eInvoiceBusinessRegionNumberPrefix
  • eInvoiceServiceProviderNumberPrefix
  • eInvoiceTemplateNumberPrefix

  See 200 response sample in JSON format.