2023 REST API Changelog

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

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

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.

Doc updates

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

• Corrected the enum values for the ListPriceBase field by removing redundant underscores in the following operations:
  • CRUD: Create a product rate plan charge
  • CRUD: Retrieve a product rate plan charge
  • CRUD: Update a product rate plan charge
• Updated the availability notes for the Offer and Price Book Item related operations to indicate that these objects and operations are in the Beta phase.
• In the source YAML file, renamed the PostContactType definition to PostCreateInvoiceContactType and updated its description for each of the following operations:
  • Create a standalone invoice
  • Create standalone invoices
• In the request body of the "Create a notification definition" operation, corrected the following fields from required to optional:
  • callout > eventTypeName
  • callout > requiredAuth
• In the request body of the "Update a notification definition" operation, corrected the following fields from required to optional:
  • callout > calloutBaseurl
  • callout > httpMethod
  • callout > name
  • callout > requiredAuth
• In the request body of each of the following operations:
  • Create a notification definition
  • Update a notification definition

  Made the following updates:

  • Updated the description of the callout > requiredAuth field for better clarity.
  • Added the following missing fields:
    • callout > requiredOauth2
    • callout > oauth2ProviderId
• In the 200 response body of each of the following operations:
  • Create a notification definition
  • Update a notification definition
  • Retrieve a notification definition

  Made the following updates:

  • Updated the description of the callout > requiredAuth field for better clarity.
  • Added the following missing fields:
    • callout > requiredOauth2
    • callout > oauth2ProviderId
• In the 200 response body of the "List notification definitions" operator, made the following updates:
  • Updated the description of the data > callout > requiredAuth field for better clarity.
  • Added the following missing fields:
    • data > callout > requiredOauth2
    • data > callout > oauth2ProviderId
• Made the following updates to add the missing clarification that these fields are also available for the Order to Revenue feature:
  • In the request body of each of the following operations:
    • Create an order
    • Create an order asynchronously
    • Update an order

    Updated the description 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
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • In the request body of each of the following operations:
    • Preview an order
    • Preview an order asynchronously

    Updated the description 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
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • subscriptions > orderActions > changePlan > newProductRatePlan > 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

    Updated the description 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
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBillingFromRevenueAccounting
  • In the response body of the "Retrieve an order" operation, updated the description 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
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBookingFromRevenueAccounting
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > excludeItemBillingFromRevenueAccounting
• In the source YAML file, duplicated the CreateOrderChargeOverride reference object as a new reference object called ChangePlanChargeOverride , which is used in the following locations:
  • 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
  • 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
  • In the response body of the "Retrieve an order" operation
• Updated the request sample of each of the following operations:
  • List API volume summary records
  • List billing document volume summary records
  • List payment volume summary records

The following updates applies to the Older API Reference:

• In the request body of the "Subscribe" action, removed the limitation note for the Invoice Settlement feature from the description of the subscribes > SubscribeOptions > ProcessPayments field.
• In the request body of the "Amend" action, removed the limitation note for the Invoice Settlement feature from the description of the requests > AmendOptions > ProcessPayments field.
• In the request body of the "CRUD: Create a bill run" operation, updated the description of the Batch field for better clarity.

November 3, 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.

• Settings - Added the support for GET and PUT methods to the StandaloneOrders setting.

  See 200 response sample in JSON format and 200 response sample in CSV 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 minimum and maximum character limits on the fields of string type:
  • Create an order
  • Update an order
  • Activate an order
• In the response body of the "Cancel a subscription" operation, updated the description of the cancelledDate field to clarify that this field is not available in the Orders tenants .

October 27, 2023

• API updates
  • API updates in Release 2023.10.R2
    • API updates for the E-Invoicing feature
    • Other API updates
  • API updates in Release 2023.11.R1
    • API updates for the Multi-Org feature
    • API updates for the Flexible Billing Attributes feature
    • API updates for the Standalone Orders feature
    • Other API updates
• Doc updates

API updates

This section lists operations and fields that were added, changed, or removed. See the following list for a quick reference:

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

API updates in Release 2023.10.R2

API updates for the E-Invoicing feature

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

Note: The E-Invoicing feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

• E-Invoicing - Added a section called E-Invoicing, containing the following operations:
  • Create an e-invoicing service provider
  • Update an e-invoicing service provider
  • Retrieve an e-invoicing service provider
  • List e-invoicing service providers
  • Delete an e-invoicing service provider
  • Create an e-invoicing business region
  • Update an e-invoicing business region
  • Retrieve an e-invoicing business region
  • List e-invoicing business regions
  • Delete an e-invoicing business region
  • Create an e-invoice file template
  • Update an e-e-invoice file template
  • Retrieve an e-invoice file template
  • List e-invoice file templates
  • Delete an e-invoice file template
• Accounts - Made the following updates:
  • In the request body of each of the following operations, added the einvoiceProfile field and its nested fields:
    • Create an account
    • Update an account
  • In the response body of the "Retrieve an account" operation, added the einvoiceProfile field and its nested fields.
• Invoices - Made the following updates:
  • Added an operation called "Generate an e-invoice file for an invoice".
  • In the response body of the "Retrieve an invoice" operation, added the following fields:
    • eInvoiceStatus
    • eInvoiceErrorCode
    • eInvoiceErrorMessage
    • eInvoiceFileId
• Credit Memos - Made the following updates:
  • Added an operation called "Generate an e-invoice file for a credit memo".
  • In the response body of each of the following operations
    • Create credit memos
    • Update credit memos

    Added the following fields:

    • memos > eInvoiceStatus
    • memos > eInvoiceErrorCode
    • memos > eInvoiceErrorMessage
    • memos > eInvoiceFileId
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • eInvoiceStatus
    • eInvoiceErrorCode
    • eInvoiceErrorMessage
    • eInvoiceFileId
  • In the response body of the "List credit memos" operation, added the following fields:
    • creditmemos > eInvoiceStatus
    • creditmemos > eInvoiceErrorCode
    • creditmemos > eInvoiceErrorMessage
    • creditmemos > eInvoiceFileId
• Debit Memos - Made the following updates:
  • Added an operation called "Generate an e-invoice file for a debit memo".
  • In the response body of each of the following operations
    • Create debit memos
    • Update debit memos

    Added the following fields:

    • memos > eInvoiceStatus
    • memos > eInvoiceErrorCode
    • memos > eInvoiceErrorMessage
    • memos > eInvoiceFileId
  • In the response body of each of the following operations:
    • 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

    Added the following fields:

    • eInvoiceStatus
    • eInvoiceErrorCode
    • eInvoiceErrorMessage
    • eInvoiceFileId
  • In the response body of the "List debit memos" operation, added the following fields:
    • debitmemos > eInvoiceStatus
    • debitmemos > eInvoiceErrorCode
    • debitmemos > eInvoiceErrorMessage
    • debitmemos > eInvoiceFileId
• Files - For the "Retrieve a file" operation, added support for retrieving e-invoicing files.

Other API updates

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

• Payment Methods - In the request body of the "Create a payment method" operation, made the following updates for the newly supported tokenization of payment methods on Adyen and Stripe:
  • Added the following fields:
    • tokens and its nested fields
    • tokenize
    • accountMaskNumber
  • Updated the description of each of the following fields:
    • IBAN
    • accountNumber
• Accounts - In the response body of the "Retrieve an account" operation, added the balance nested field to the metricsData field.

API updates in Release 2023.11.R1

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

API updates for the Multi-Org feature

The following items are the API updates specific to the Early Adopter announcement of the Multi-Org feature.

• Multiple Organizations - Added a section called "Multiple Organizations", containing the following operations:
  • Submit a data labeling job
  • Retrieve a data labeling job
• Added the Zuora-Org-Ids request header for all operations.
• Accounts - Made the following changes:
  • In the response body of each of the following operations:
    • Retrieve an account
    • Retrieve an account summary

    Added the following fields:

    • basicInfo > organizationLabel
    • basicInfo > tags
  • In the request body of the "Create an account" operation, added the following fields:
    • organizationLabel
    • tagging
• Attachments - Made the following changes:
  • In the response body of the "List attachments by object type and key" operation, added the organizationLabel nested field to the attachments field.
  • In the response body of the "Retrieve an attachment" operation, added the organizationLabel field.
• Credit Memos - Made the following changes:
  • In the response body of the "List credit memos" operation, added the organizationLabel nested field to the creditmemos field.
  • In the response body of each of the following operations, added the organizationLabel field:
    • Retrieve a credit memo
    • Retrieve a credit memo item
    • Retrieve a credit memo part
    • Retrieve a credit memo part item
    • Create a credit memo from a charge
    • Create a credit memo from an invoice
    • Update a credit memo
    • Apply a credit memo
    • Cancel a credit memo
    • Post a credit memo
    • Unapply a credit memo
    • Unpost a credit memo
  • In the response body of each of the following operations, added the organizationLabel nested field to the memos field:
    • Update credit memos
    • Create credit memos
• Debit Memos - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabel field:
    • Retrieve a debit memo
    • Create a debit memo from a charge
    • Create a debit memo from an invoice
    • Collect a posted 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 organizationLabel nested field to the memos field:
    • Create debit memos
    • Update debit memos
• Invoices - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabel field:
    • Retrieve an invoice
    • Create a standalone invoice
  • In the response body of the "Create standalone invoices" operation, added the organizationLabel nested field to the invoices field.
• Summary Journal Entries - Made the following changes:
  • In the response body of the "Retrieve a summary journal entry" operation, added the organizationLabel field.
  • In the response body of the "List all summary journal entries in a journal run" operation, added the organizationLabel nested field to the journalEntries field.
  • In the request body of the "Create a summary journal entry" operation, added the organizationLabels field and its nested fields.
• Orders - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabel 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 organizationLabel nested field to the orders field.
  • In the request body of each of the following operations:
    • Create an order
    • Update an order

    Added the following fields:

    • newAccount > organizationName
    • newAccount > tagging
• Payments - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabel field:
    • Retrieve a payment
    • Retrieve a payment part
    • Retrieve a payment part item
    • Create a payment
    • Refund a payment
    • Update a payment
    • Transfer a payment
    • Apply a payment
    • Cancel a payment
    • Unapply a payment
  • In the response body of the "List payments" operation, added the organizationLabel nested field to the payments field.
  • In the response body of the "List all parts of a payment" operation, added the organizationLabel nested field to the parts field.
  • In the response body of the "List all payment part items" operation, added the organizationLabel nested field to the itemParts field.
• Refunds - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabel field:
    • Update a refund
    • Cancel a refund
    • Retrieve a refund
    • Retrieve a refund part
    • Retrieve a refund part item
  • In the response body of the "List refunds" operation, added the organizationLabel nested field to the refunds field.
  • In the response body of the "List all parts of a refund" operation, added the organizationLabel nested field to the parts field.
  • In the response body of the "List all refund part items" operation, added the organizationLabel nested field to the itemParts field.
• Subscriptions - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabel 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 organizationLabel nested field to the subscriptions field.
• Usage - In the response body of the "Retrieve a usage record" operation, added the organizationLabel nested field to the usage field.
• Bill Run - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabels field and its nested fields.
    • Delete bill run
    • Retrieve a bill run
    • Create a bill run
    • Post a bill run
    • Cancel a bill run
  • In the request body of the "Create a bill run" operation, added organizationLabels field and its nested fields.
• Payment Gateway Reconciliation - In the response body of each of the following operations, added the organizationLabel field:
  • Settle a paymnet
  • Reject a payment
  • Reverse a payment
  • Reconcile a payment
• Bill Run Previews - Made the following changes:
  • In the response body of the "Retrieve a billing preview run" operation, added the organizationLabels field and its nested fields.
  • In the request body of the "Create a bill run preview" operation, added the organizationLabels field and its nested fields.
• Catalog Groups - Made the following changes:
  • In the response body of the "List all catalog groups" operation, added the catalogGroups > productRatePlans > organizationLabels field and its nested fields.
  • In the response body of each of the following operations, added the productRatePlans > organizationLabels field and its nested fields.
    • Retrieve a catalog group
    • Update a catalog group
• Catalog - Made the following changes:
  • In the response body of the "List all products" operation, added the products > organizationLabels field and its nested fields.
  • In the response body of the "Retrieve a product" operation, added the organizationLabels field and its nested fields.
  • In the response body of the "Retrieve a product" operation, added the tags field.
  • In the response body of the "List all products" operation, added the tags nested field to the products field.
• Journal Runs - Made the following changes:
  • In the response body of the "Retrieve a journal run" operation, added the organizationLabels field and its nested fields.
  • In the request body of each of the "Create a journal run" operation, added the organizationLabels field and its nested fields.
• Payment Runs - Made the following changes:
  • In the response body of each of the following operations, added the organizationLabels field and its nested fields.
    • Retrieve a payment run
    • Create a payment run
    • Update a payment run
  • In the response body of the "List payment runs" operation, added the paymentRun > organizationLabels field and its nested fields.
  • In the request body of each of the following operations, added the organizationLabels field and its nested fields.
    • Create a payment run
    • Update a payment run
• Product Rate Plans - In the response body of each of the following operations, added the organizationLabels field and its nested fields.
  • Retrieve a product rate plan by ID
  • List product rate plans by external ID
• Invoice Schedules - In the response body of the "Execute an invoice schedule" operation, added the organizationLabels field and its nested fields.
• Accounting Periods - Made the following changes:
  • In the response body of the "List all accounting periods" operation, added the accountingPeriods > organizationLabels field and its nested fileds.
  • In the response body of the "Retrieve an accounting period" operation, added the organizationLabels field and its nested fields.
  • In the request body of the "Create an accounting period" operation, added the organizationLabels field and its nested fields.

API updates for the Flexible Billing Attributes feature

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

• Invoices - Made the following updates:
  • In the request body of the “Create a standalone invoice” operation, added the following fields:
    • billToContact and its nested fields
    • billToContactId
    • paymentTerm
    • sequenceSet
    • soldToContact and its nested fields
    • soldToContactId
    • soldToSameAsBillTo
    • templateId
  • In the request body of the "Create standalone invoices" operation, added the following fields:
    • invoices > billToContact and its nested fields
    • invoices > billToContactId
    • invoices > paymentTerm
    • invoices > sequenceSet
    • invoices > soldToContact and its nested fields
    • invoices > soldToContact
    • invoices > soldToSameAsBillTo
    • invoices > templateId

API updates for the Standalone Orders feature

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

Note: The Standalone Orders feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

• 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

    Added the following fields:

    • subscriptions > orderActions > createSubscription > subscribeToProducts > isFromExternalCatalog
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanName
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > name
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pobPolicy
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productCategory
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productClass
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productFamily
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productLine
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > chargeType
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > chargeModel
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > taxCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > taxMode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > name
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pobPolicy
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productCategory
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productClass
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productFamily
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productLine
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > chargeType
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > chargeModel
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > taxCode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > taxMode
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > isFromExternalCatalog
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > ratePlanName
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > name
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pobPolicy
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productCategory
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productClass
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productFamily
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productLine
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxMode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > addProduct > isFromExternalCatalog
    • subscriptions > orderActions > addProduct > ratePlanName
    • subscriptions > orderActions > addProduct > chargeOverrides > name
    • subscriptions > orderActions > addProduct > chargeOverrides > pobPolicy
    • subscriptions > orderActions > addProduct > chargeOverrides > productCategory
    • subscriptions > orderActions > addProduct > chargeOverrides > productClass
    • subscriptions > orderActions > addProduct > chargeOverrides > productFamily
    • subscriptions > orderActions > addProduct > chargeOverrides > productLine
    • subscriptions > orderActions > addProduct > chargeOverrides > chargeType
    • subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • subscriptions > orderActions > addProduct > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > taxCode
    • subscriptions > orderActions > addProduct > chargeOverrides > taxMode
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > name
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pobPolicy
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productCategory
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productClass
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productFamily
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productLine
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > chargeType
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > chargeModel
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > taxCode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > taxMode
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > isFromExternalCatalog
    • subscriptions > orderActions > changePlan > newProductRatePlan > ratePlanName
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > name
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pobPolicy
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productCategory
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productClass
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productFamily
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productLine
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxMode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usageVolume > uom
  • In the request body of each of the following operations:
    • Preview an order
    • Preview an order asynchronously

    Added the following fields:

    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > isFromExternalCatalog
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > ratePlanName
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > name
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pobPolicy
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productCategory
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productClass
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productFamily
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productLine
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxCode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxMode
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > addProduct > isFromExternalCatalog
    • subscriptions > orderActions > addProduct > ratePlanName
    • subscriptions > orderActions > addProduct > chargeOverrides > name
    • subscriptions > orderActions > addProduct > chargeOverrides > pobPolicy
    • subscriptions > orderActions > addProduct > chargeOverrides > productCategory
    • subscriptions > orderActions > addProduct > chargeOverrides > productClass
    • subscriptions > orderActions > addProduct > chargeOverrides > productFamily
    • subscriptions > orderActions > addProduct > chargeOverrides > productLine
    • subscriptions > orderActions > addProduct > chargeOverrides > chargeType
    • subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • subscriptions > orderActions > addProduct > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > addProduct > chargeOverrides > taxCode
    • subscriptions > orderActions > addProduct > chargeOverrides > taxMode
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > isFromExternalCatalog
    • subscriptions > orderActions > changePlan > newProductRatePlan > ratePlanName
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > name
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pobPolicy
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productCategory
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productClass
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productFamily
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productLine
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > accountReceivableAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentLiabilityAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractAssetAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractLiabilityAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractRecognizedRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > deferredRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > recognizedRevenueAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > unBilledReceivablesAccountingCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxCode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxMode
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeVolume > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringVolume > uom
    • subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usageVolume > 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 fields:

    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > isFromExternalCatalog
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanName
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > name
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pobPolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productCategory
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productClass
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productFamily
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productLine
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > chargeType
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > accountReceivableAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > adjustmentLiabilityAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > adjustmentRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractAssetAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractLiabilityAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractRecognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > deferredRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > recognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > unBilledReceivablesAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > taxCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > taxMode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimePerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringPerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usagePerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimeVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usageVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > name
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pobPolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productCategory
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productClass
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productFamily
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productLine
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > chargeType
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > accountReceivableAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > adjustmentLiabilityAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > adjustmentRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractAssetAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractLiabilityAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractRecognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > deferredRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > recognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > unBilledReceivablesAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > taxCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > taxMode
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimeVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usageVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > isFromExternalCatalog
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > ratePlanName
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > name
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pobPolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productCategory
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productClass
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productFamily
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productLine
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > accountReceivableAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentLiabilityAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractAssetAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractLiabilityAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractRecognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > deferredRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > recognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > unBilledReceivablesAccountingCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxCode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxMode
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringVolume > uom
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > uom
    • orders > subscriptions > orderActions > addProduct > isFromExternalCatalog
    • orders > subscriptions > orderActions > addProduct > ratePlanName
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > name
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pobPolicy
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > productCategory
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > productClass
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > productFamily
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > productLine
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeType
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > accountReceivableAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > adjustmentLiabilityAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > adjustmentRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > contractAssetAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > contractLiabilityAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > contractRecognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > deferredRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > recognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > unBilledReceivablesAccountingCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > taxCode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > taxMode
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > uom
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > uom
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > uom
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeVolume > uom
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringVolume > uom
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > uom
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > name
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pobPolicy
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productCategory
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productClass
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productFamily
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productLine
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > chargeType
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > accountReceivableAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > adjustmentLiabilityAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > adjustmentRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractAssetAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractLiabilityAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractRecognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > deferredRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > recognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > unBilledReceivablesAccountingCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > taxCode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > taxMode
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > uom
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > uom
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > uom
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimeVolume > uom
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringVolume > uom
    • orders > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usageVolume > uom
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > isFromExternalCatalog
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > ratePlanName
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > name
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pobPolicy
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productCategory
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productClass
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productFamily
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productLine
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > accountReceivableAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentLiabilityAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentRevenueAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractAssetAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractLiabilityAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractRecognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > deferredRevenueAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > recognizedRevenueAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > unBilledReceivablesAccountingCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxCode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxMode
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > uom
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > uom
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > uom
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeVolume > uom
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringVolume > uom
    • orders > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usageVolume > uom
  • In the response body of the "Retrieve an order" operation, added the following fields:
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > isFromExternalCatalog
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanName
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > name
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pobPolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productCategory
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productClass
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productFamily
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > productLine
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > chargeType
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > accountReceivableAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > adjustmentLiabilityAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > adjustmentRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractAssetAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractLiabilityAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > contractRecognizedRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > deferredRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > recognizedRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > unBilledReceivablesAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > taxCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > taxMode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimePerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringPerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usagePerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > oneTimeVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > recurringVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > usageVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > name
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pobPolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productCategory
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productClass
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productFamily
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > productLine
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > chargeType
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > accountReceivableAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > adjustmentLiabilityAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > adjustmentRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractAssetAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractLiabilityAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > contractRecognizedRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > deferredRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > recognizedRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > unBilledReceivablesAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > taxCode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > taxMode
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > oneTimeVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > recurringVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > usageVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > isFromExternalCatalog
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > ratePlanName
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > name
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pobPolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productCategory
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productClass
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productFamily
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > productLine
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeType
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > accountReceivableAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentLiabilityAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > adjustmentRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractAssetAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractLiabilityAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > contractRecognizedRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > deferredRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > recognizedRevenueAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > unBilledReceivablesAccountingCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxCode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > taxMode
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimePerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringPerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usagePerUnit > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringVolume > uom
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > uom
    • order > subscriptions > orderActions > addProduct > isFromExternalCatalog
    • order > subscriptions > orderActions > addProduct > ratePlanName
    • order > subscriptions > orderActions > addProduct > chargeOverrides > name
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pobPolicy
    • order > subscriptions > orderActions > addProduct > chargeOverrides > productCategory
    • order > subscriptions > orderActions > addProduct > chargeOverrides > productClass
    • order > subscriptions > orderActions > addProduct > chargeOverrides > productFamily
    • order > subscriptions > orderActions > addProduct > chargeOverrides > productLine
    • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeType
    • order > subscriptions > orderActions > addProduct > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > addProduct > chargeOverrides > accountReceivableAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > adjustmentLiabilityAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > adjustmentRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > contractAssetAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > contractLiabilityAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > contractRecognizedRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > deferredRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > recognizedRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > unBilledReceivablesAccountingCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > taxCode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > taxMode
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimePerUnit > uom
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringPerUnit > uom
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usagePerUnit > uom
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeVolume > uom
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringVolume > uom
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > uom
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > name
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pobPolicy
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productCategory
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productClass
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productFamily
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > productLine
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > chargeType
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > accountReceivableAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > adjustmentLiabilityAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > adjustmentRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractAssetAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractLiabilityAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > contractRecognizedRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > deferredRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > recognizedRevenueAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > unBilledReceivablesAccountingCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > taxCode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > taxMode
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimePerUnit > uom
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringPerUnit > uom
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usagePerUnit > uom
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > oneTimeVolume > uom
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > recurringVolume > uom
    • order > subscriptions > orderActions > addProduct > ratePlanOverrides > chargeOverrides > pricing > usageVolume > uom
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > isFromExternalCatalog
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > ratePlanName
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > name
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pobPolicy
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productCategory
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productClass
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productFamily
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > productLine
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeType
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > chargeModel
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > accountReceivableAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentLiabilityAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > adjustmentRevenueAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractAssetAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractLiabilityAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > contractRecognizedRevenueAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > deferredRevenueAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > recognizedRevenueAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > unBilledReceivablesAccountingCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxCode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > taxMode
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeFlatFee > originalListPrice
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringFlatFee > originalListPrice
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > originalListPrice
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimePerUnit > uom
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > originalListPrice
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringPerUnit > uom
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > originalListPrice
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usagePerUnit > uom
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > oneTimeVolume > uom
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > recurringVolume > uom
    • order > subscriptions > orderActions > changePlan > newProductRatePlan > chargeOverrides > pricing > usageVolume > uom

Other API updates

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

• Delivery Adjustments - In the response body of each of the following operations, renamed the totalQuantity field to totalNumberOfDeliveries .
  • Create a delivery adjustment
  • Preview a delivery adjustment
• Subscriptions - Made the following changes:
  • In the response body of the "List subscriptions by account key" operation, added the numberOfDeliveries nested field to the subscriptions > ratePlans > ratePlanCharges field.
  • In the response body of each of the following operations, added the numberOfDeliveries nested field to the ratePlans > ratePlanCharges field.
    • Retrieve a subscription by key
    • Retrieve a subscription by key and version
• Settings - Made the following updates:
  • Added the Specific_Days enum value to the billingPeriods parameter of the BillingPeriod setting.
  • Added the following parameters to the NumberAndSku setting:
    • creditMemoTemplateNumberPrefix
    • debitMemoTemplateNumberPrefix
    • invoiceTemplateNumberPrefix
    • productNumberPrefix
    • productRatePlanChargeNumberPrefix
    • productRatePlanNumberPrefix
    • sequenceSetNumberPrefix
    • subscriptionRatePlanNumberPrefix
  • Updated the voidTemplate parameter of each of the following settings to add the support of the null value:
    • AllTaxEngines
    • CreateGlobalTaxHubTaxEngine
    • GlobalTaxHubTaxEngine

  See 200 response sample in JSON format.

• Aggregate Queries - Made the following updates:
  • In the request body of the "Submit an aggregate query job" operation, added the following fields:
    • sourceData
    • warehouseSize
  • In the 200 response body of each of the following operations, added the sourceData field:
    • Submit an aggregate query job
    • Retrieve an aggregate query job
    • Cancel a running aggregate query job
    • Retrieve the last completed aggregate query job
• Data Queries - Made the following updates:
  • In the request body of the "Submit a data query" operation, made the following updates:
    • Updated the description of the sourceData field to add the support of the Zuora Warehouse feature.
    • Added the warehouseSize field.
  • In the 200 response body of each of the following operations, added the sourceData nested field to the data field:
    • Submit a data query
    • List data query jobs
    • Retrieve a data query job
    • Cancel a data query job

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 product charge definition" operation, removed the productChargeDefinitionId and productChargeDefinitionNumber fields.
• In the request body of each of the following operations:
  • Create a product charge definition
  • Update a product charge definition

  Made the following updates:

  • Corrected the enum values of the chargeModel field.
  • Updated the format of each of the effectiveStartDate and effectiveEndDate fields.
• In the response body of the "Retrieve a product charge definition" operations, made the following updates:
  • Corrected the enum values of the chargeModel field.
  • Updated the format of each of the effectiveStartDate and effectiveEndDate fields.
• In the response body of the "List product charge definitions", made the following updates:
  • Corrected the enum values of the chargeDefinitions > chargeModel field.
  • Updated the format of each of the chargeDefinitions > effectiveStartDate and chargeDefinitions > effectiveEndDate fields.
• Updated the description of each of the recurringDelivery and recurringDeliveryBased fields to clarify the access approach. 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
• In the 200 response body of each of the following operations, added the missing useIndexJoin nested field to the data field:
  • Submit a data query
  • List data query jobs
  • Retrieve a data query job
  • Cancel a data query job
• In the request sample of the "Update credit memo" operation, corrected the format of the id field.
• Updated the request sample of each of the following operations:
  • List API volume summary records
  • List billing document volume summary records
  • List payment volume summary records
• In the response body of the "Create a payment schedule" operation, updated the description of the totalAmount field.
• In the request body of the "Update a payment schedule" operation, added a note to the paymentOption field.

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

• Invoices - Made the following updates:
• In the response body of the "List all items of an invoice" operation, added the property name* nested field to the invoiceItems > taxationItems > data field for supporting custom fields on the Invoice Taxation Item object.
• In the response body of the "List all taxation items of an invoice item" operation, added the property name* nested field to the data field for supporting custom fields on the Invoice Taxation Item object.

Doc updates

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

• For operations in the following sections, updated the availability note to indicate that you must reach out to your CSM if you want to access the operations in the Early Adopter phase.
  • Product Rate Plan Definitions
  • Product Charge Definitions
• In the description of the "List subscriptions by account key" operation, added a note about the return order of rate plan charges in a subscription.

October 13, 2023

API updates

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

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

API updates for the Attribute-based Pricing feature

The following items are the API updates specific to the Early Adopter announcement of the Attribute-based Pricing feature.

• Product Rate Plan Definitions - Added a section called "Product Rate Plan Definitions", containing the following operations:
  • Create a product rate plan definition
  • Delete a product rate plan definition
  • List product rate plan definitions
  • Retrieve a product rate plan definition
• Product Charge Definitions - Added a section called "Product Charge Definitions", containing the following operations:
  • Create a product charge definition
  • Delete a product charge definition
  • List product charge definitions
  • Retrieve a product charge definition
  • Update a product charge definition
• Product Rate Plan Charges - Added an operation called "Retrieve a product rate plan charge" to facilitate retrieving a charge information including its charge definition information.

Other API updates

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

• Custom Event Triggers - Made the following updates:
  • Updated the description of the "Custom Event Triggers" section to add the support for custom objects.
  • Updated the description of the "Create an event trigger" operation to add the support for custom objects.
  • In the request body of the "Create an event trigger" operation, updated the description of the baseObject field.
  • In the 200 response body of each of the following operations, updated the description of the baseObject field:
    • Create an event trigger
    • Retrieve an event trigger
    • Update an event trigger
  • In the "List event triggers" operation, updated the description of the baseObject query parameter.
  • In the 200 response body of the "List event triggers" operation, updated the description of the data > baseObject field.

Doc updates

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

• For the "List records for a custom object" operation, removed the unsupported page query parameter.
• In the description of the "Create an order" operation, added the description for the Scheduled Orders feature.
• 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 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 by subscription number
  • List orders of an invoice owner
• In the response body of the "Retrieve an order" operation, updated the description of the status and schedulingOptions nested fields of the order field for better clarity.
• In the request body of each of the following operations, updated the character length of the personalEmail and workEmail fields.
  • Create a contact
  • Update a contact
• In the response body of each of the following operations, updated the character length of the personalEmail and workEmail fields.
  • Create a contact
  • Retrieve a contact
  • Update a contact
• In the request body and response body of the "Create a payment" operation, removed the version control information from the paymentOption field because this field is no longer version controlled.
• In the response body of the "List payments" operation, removed the version control information from the payments > paymentOption field description because this field is no longer version controlled.
• Removed the version control information from the description of the paymentOption field on the Payment Schedule object and Payment Schedule Item object because these fields are no longer version controlled. The following operations are affected:
  • Create a payment schedule
  • Retrieve a payment schedule
  • Create multiple payment schedules at once
  • Add payment schedule items to a custom payment schedule
  • Update a payment schedule
  • Update a payment schedule item
  • Preview the result of payment schedule update
  • Retrieve a payment schedule item
  • List payment schedules by customer account
  • Cancel a payment schedule
  • Cancel a payment schedule item
  • Skip a payment schedule item
  • Retry failed payment schedule items
• In the response body of the "Retrieve an account" operation, updated the description of the metrics field for better clarity.

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

API updates for the Enhanced Discounts feature

The following items are the API updates specific to the Enhanced Discounts feature.

• 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

    Added the following fields:

    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > periodsAfterChargeStart
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > startDatePolicy
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > startPeriodsType
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > endDate > endDatePolicy
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > discountClass
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > periodsAfterChargeStart
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > startDatePolicy
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > startPeriodsType
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > endDate > endDatePolicy
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > discountApplyDetails
    • subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > discountClass
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > periodsAfterChargeStart
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > startDatePolicy
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > startPeriodsType
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > endDate > endDatePolicy
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > discountClass
    • subscriptions > orderActions > addProduct > chargeOverrides > startDate > periodsAfterChargeStart
    • subscriptions > orderActions > addProduct > chargeOverrides > startDate > startDatePolicy
    • subscriptions > orderActions > addProduct > chargeOverrides > startDate > startPeriodsType
    • subscriptions > orderActions > addProduct > chargeOverrides > endDate > endDatePolicy
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > discountClass
  • 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 > createSubscription > subscribeToProducts > chargeOverrides > startDate > periodsAfterChargeStart
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > startDatePolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > startPeriodsType
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > endDate > endDatePolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > discountClass
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > periodsAfterChargeStart
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > startDatePolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > startPeriodsType
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > endDate > endDatePolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > discountApplyDetails
    • orders > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > discountClass
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > periodsAfterChargeStart
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > startDatePolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > startPeriodsType
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > endDate > endDatePolicy
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > discountApplyDetails and nested fields
    • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > discountClass
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > startDate > periodsAfterChargeStart
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > startDate > startDatePolicy
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > startDate > startPeriodsType
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > endDate > endDatePolicy
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • orders > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > discountClass
  • In the response body of the "Retrieve an order" operation, added the following fields:
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > periodsAfterChargeStart
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > startDatePolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > startDate > startPeriodsType
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > endDate > endDatePolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > chargeOverrides > pricing > discount > discountClass
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > periodsAfterChargeStart
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > startDatePolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > startDate > startPeriodsType
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > endDate > endDatePolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > discountApplyDetails
    • order > subscriptions > orderActions > createSubscription > subscribeToProducts > ratePlanOverrides > chargeOverrides > pricing > discount > discountClass
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > periodsAfterChargeStart
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > startDatePolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > startPeriodsType
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > endDate > endDatePolicy
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > discount > discountClass
    • order > subscriptions > orderActions > addProduct > chargeOverrides > startDate > periodsAfterChargeStart
    • order > subscriptions > orderActions > addProduct > chargeOverrides > startDate > startDatePolicy
    • order > subscriptions > orderActions > addProduct > chargeOverrides > startDate > startPeriodsType
    • order > subscriptions > orderActions > addProduct > chargeOverrides > endDate > endDatePolicy
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > applyToBillingPeriodPartially
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > discountApplyDetails and its nested fields
    • order > subscriptions > orderActions > addProduct > chargeOverrides > pricing > discount > discountClass
• Subscriptions - Made the following changes:
  • 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 > applyToBillingPeriodPartially
    • offers > ratePlans > ratePlanCharges > applyToBillingPeriodPartially
  • In the response body of the "List subscriptions by account key" operation, added the following fields:
    • subscriptions > ratePlans > ratePlanCharges > applyToBillingPeriodPartially
    • offers > ratePlans > ratePlanCharges > applyToBillingPeriodPartially
• Product Rate Plan Charges - Made the following changes:
  • In the request body of each of the following operations, added the applyToBillingPeriodPartially field:
    • CRUD: Create a product rate plan charge
    • CRUD: Update a product rate plan charge
  • In the response body of the "CRUD: Retrieve a product" operation, added the applyToBillingPeriodPartially field.