API Changelog

[Jing]

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

  2020-09-10

   

• Doc Updates

• This version is a correction to the previous 2020-09-08 version. In the 2020-09-08 version, some updates related to Charge Metrics, Ramps, and Orders general availability were missing from the API Reference. The 2020-09-10 version is a fix to this.

[Jing]

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

    2020-09-17

  •  

  •  

  • 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 Apple Pay payment method" operation, added the following missing fields:
      • mitProfileAction
      • mitConsentAgreementSrc
      • mitProfileType

    • In the request body of the "CRUD: Get account" operation, corrected the field name of the CommunicationProfileId field.

    • In the request body of the "Cancel subscription" operation, added the missing contractEffectiveDate field.

    • Changed the name of the Zuora Object Model section to Zuora Billing Object Model, and updated related reference links.

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

    • In the request body of the "Create summary journal entry" operation, updated the description of the segmentName field.

    • In the descriptions of the Create action and the following operations, added links to related use cases in the API Guides.

      • Create a notification definition
      • Create credit memo from invoice
      • Create credit memo from charge
      • Create order
      • CRUD: Update contact
      • CRUD: Update payment method
      • Delete payment method
      • Get credit memo
      • Get credit memos
      • Get invoices
      • Get product catalog
      • Get product rate plans
      • Post usage
      • Preview order
      • Refund payment
      • Refund credit memo
      • Update account

    • Removed the Charge Metrics operations that are not supported yet.

[Jing]

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

  2020-09-25

•  

• API Updates

•  

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

• The following API updates are available as of September 25, 2020.

• • Orders - Made the following updates:

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

      • subscriptions > orderActions > addProduct > chargeOverrides > pricing > chargeModelData
      • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData
      • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData

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

      • Get an order
      • Get order metrics for evergreen subscription

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

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

  • Product Rate Plan Charges - Made the following updates:

    • In the following operations, added the X-Zuora-WSDL-Version request header parameter:
      • CRUD: Create product rate plan charge
      • CRUD: Update product rate plan charge
    • In the request body of the "CRUD: Create product rate plan charge" and "CRUD: Update product rate plan charge" operations, added the following enum values to the ChargeModel field:
      • MultiAttributePricing
      • PreratedPerUnit
      • PreratedPricing
      • HighWaterMarkVolumePricing
      • HighWaterMarkTieredPricing
    • In the request body of each of the following operations, added the ChargeModelConfiguration field and its nested fields.
      • CRUD: Create product rate plan charge
      • CRUD: Update product rate plan charge

  • Product Rate Plans - In the response body of the "Get product rate plans" operation, added the following nested fields to the productRatePlans > productRatePlanCharges field:

    • chargeModelConfiguration
    • formula

   

• Doc Updates

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

• • In the "Access to the API" section, added the base URLs for REST endpoints of the following enviroments:

    • US Cloud Production
    • US Cloud API Sandbox
    • US Central Sandbox
    • EU Central Sandbox

  • In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, corrected the name of the ChargeModelConfiguration nested field to chargeModelConfiguration in the following fields:

    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > chargeModelData
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData

  • In the response body of the following operations, corrected the name of the ChargeModelConfiguration nested field to chargeModelConfiguration for the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData field:

    • Get an order
    • Get order metrics for evergreen subscription

  • In the response body of the following operations, corrected the name of the ChargeModelConfiguration nested field to chargeModelConfiguration for the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData field:

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

  • In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, updated the following fields from optional to required:

    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeTiered > tiers > priceFormat
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > oneTimeVolume > tiers > priceFormat
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringTiered > tiers > priceFormat
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > recurringVolume > tiers > priceFormat
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTiered > tiers > priceFormat
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageTieredWithOverage > tiers > priceFormat
    • subscriptions > orderActions > addProduct > chargeOverrides > pricing > usageVolume > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > oneTimeTiered > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > oneTimeVolume > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > recurringTiered > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > recurringVolume > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageTiered > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageTieredWithOverage > tiers > priceFormat
    • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > usageVolume > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeTiered > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > oneTimeVolume > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringTiered > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > recurringVolume > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTiered > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageTieredWithOverage > tiers > priceFormat
    • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > usageVolume > tiers > priceFormat

[Jing]

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

  2020-09-30

•  

• API Updates

•  

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

• The following API updates are available as of September 30, 2020.

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

• The High Water Mark Volume Pricing, High Water Mark Tiered Pricing, Pre-Rated Per Unit Pricing, Pre-Rated Pricing, and Multi-Attribute Pricing charge models are now generally available as of September 30, 2020. The following updates are specific to these charge models.

• • Subscriptions - Made the following updates

    • In the request body of each of the following operations, updated the description of the subscribeToRatePlans > chargeOverrides > chargeModelConfiguration field and its nested fields:
      • Preview subscription
      • Create subscription
    • In the request body of the "Update subscription" operations, updated the description of each of the following fields and their nested fields:
      • add > chargeOverrides > chargeModelConfiguration
      • update > chargeUpdateDetails > chargeModelConfiguration
    • In response body of the "Get subscriptions by account" operation, updated the description of the subscriptions > ratePlans > ratePlanCharges > chargeModelConfiguration field and its nested fields.
    • In response body of the following operations, updated the description of the ratePlans > ratePlanCharges > chargeModelConfiguration field and its nested fields:
      • Get subscriptions by key
      • Get subscriptions by key and version

  • Orders - Made the following updates:

    • In the request body of the "Create order", "Create order asynchronously", "Preview order", and "Preview order asynchronously" operations, updated the description of each of the following fields and their nested fields:

      • subscriptions > orderActions > addProduct > chargeOverrides > pricing > chargeModelData
      • subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData
      • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData

    • In the response body of each of the following operations, updated the description of the order > subscriptions > orderActions > updateProduct > chargeUpdates > pricing > chargeModelData field and its nested fields:

      • Get an order
      • Get order metrics for evergreen subscription

    • In the response body of the following operations, updated the description of the orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > pricing > chargeModelData field and its nested fields:

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

  • Product Rate Plan Charges - Made the following updates:

    • In the request body of the "CRUD: Create product rate plan charge" and "CRUD: Update product rate plan charge" operations, updated the description of each of the following enum values for the ChargeModel field:
      • MultiAttributePricing
      • PreratedPerUnit
      • PreratedPricing
      • HighWaterMarkVolumePricing
      • HighWaterMarkTieredPricing
    • In the request body of each of the following operations, updated the description of the ChargeModelConfiguration field and its nested fields:
      • CRUD: Create product rate plan charge
      • CRUD: Update product rate plan charge

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

    • Updated the description of each of the following fields:
      • productRatePlans > productRatePlanCharges > pricingSummary
      • formula
    • Updated the description of each of the following enum values for the productRatePlans > productRatePlanCharges > model field:
      • MultiAttributePricing
      • PreratedPerUnit
      • PreratedPricing
      • HighWatermarkVolumePricing
      • HighWatermarkTieredPricing

   

• 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 notification definition” operation, updated the description of the eventTypeNamespace field.

[Jing]

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

  2020-10-14

•  

• API Updates

•  

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

• The following API updates are available as of Zuora Billing Release 287, October 2020.

• • Accounts - In the request body of the "Create account" operation, added the following fields:

    • applyCredit
    • applicationOrder

  • Subscriptions - Made the following updates:

    • In the request body of each of the following operations, added the applyCredit and applicationOrder fields:

      • Create subscription
      • Update subscription
      • Renew subscription
      • Cancel subscription
      • Resume subscription
      • Suspend subscription

    • In the request body of the "CRUD: Update Subscription" operation, enhanced the following fields to support directly updating the subscription trigger dates for Order customers. If you are Zuora's Subscribe and Amend customers, you already have the access to this feature.

      • ContractEffectiveDate
      • ServiceActivationDate
      • ContractAcceptanceDate

  • Orders - In the request body of the "Create order" and "Create order asynchronously" operations, added the following nested fields to the processingOptions field:

    • applyCredit
    • applicationOrder

  • Invoices - Made the following updates:

    • In the request body of each of the following operations, added the taxMode nested field to the the items field:
      • Create credit memo from invoice
      • Create debit memo from invoice
    • In the request body of the "CRUD: Update invoice" operation, changed the behavior of the RegenerateInvoicePDF field. This field is now valid only if you enable the billing document file generation feature.

  • Credit Memos - Made the following updates:

    • In the response body of the "Get credit memo items" operation, added the taxMode nested field to the items field.
    • In the response body of the "Get credit memo item" operation, added the taxMode field.
    • Changed the behavior of the "Create credit memo PDF" operation. This REST API operation now can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled.

  • Debit Memos - Made the following updates:

    • In the response body of the "Get debit memo items" operation, added the taxMode nested field to the items field.
    • In the response body of the "Get debit memo item" operation, added the taxMode field.
    • Changed the behavior of the "Create debit memo PDF" operation. This REST API operation now can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled.

   

• Doc Updates

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

• • In the response body of the “Get account summary” operation, corrected the type of the invoices > amount field to number.

  • In the "Get charge metrics" operation, corrected the endpoint to /charge-metrics/data/charge-metrics.

  • In the "Get discount allocation details" operation, corrected the endpoint to /charge-metrics/data/charge-metrics-discount-allocation-detail.

  • Made the following updates to state that the duration of a renewal term cannot be greater than 10 years.

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

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

      Updated the description for each of the following fields:

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

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

      • Get an order
      • Get order metrics for evergreen subscription

      Updated the description for each of the following fields:

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

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

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

      Updated the description for each of the following fields:

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

[Jing]

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

2020-10-23

Doc Updates

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

• In the request body of the “Submit data query” operation, added a note to the description of the encryptionKey field.
• Changed the title of the API Reference from "Zuora API Reference" to "API Reference: Billing".

[Jing]

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

  2020-10-30

  Doc Updates

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

  • In the request body of the "CRUD: Create credit balance adjustment" operation, corrected the description of the following fields:
    • SourceTransactionId
    • SourceTransactionNumber

[Jing]

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

  2020-11-05

  API Updates

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

• The following API updates are available as of Zuora Billing Release 288, November 2020.

•  

• • Orders - Made the following updates:

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

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

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

      • Get an order
      • Get order metrics for evergreen subscription

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

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

    • In the request body of the "Update order custom fields" operation, added the orderActionId nested field to the subscriptions > orderActions field.

    • In the response body of each of the following operations, added the id nested field to the order > subscriptions > orderActions field:

      • Get an order
      • Get order metrics for evergreen subscription

    • In the response body of each of the following operations, added the id nested field to the orders > subscriptions > orderActions field:

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

  • Invoices - Made the following updates:

    • In the response body of the "Get invoice items" operation, added the unitPrice nested field to the invoiceItems field.
    • In the request body of the following operations, added a limit to the items field:
      • Create credit memo from invoice
      • Create debit memo from invoice

  • Credit Memos - In the request body of the "Create credit memo from charge" operation, added a limit to the charges field.

  • Debit Memos - In the request body of the "Create debit memo from charge" operation, added a limit to the charges field.

  • Billing Preview Runs - In the response body of the "Get billing preview run" operation, changed the value of the resultFileUrl field and updated the response sample correspondingly.

  • Mass Updater - In the response body of the "Get mass action result" operation, changed the value of the outputURL field and updated the response sample correspondingly.

  • Credit Balance Adjustments - In the request body of the "CRUD: Create credit balance adjustment" operation, added the AdjustmentDate field.

  • Refunds - In the request body of the "CRUD: Create refund" operation, changed the behavior of the RefundDate field.

   

• Doc Updates

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

• • In the source YAML file, added the QuoteObjectFields reference object. This change affects the following operations:
    • Create order
    • Create order asynchronously
    • Preview order
    • Preview order asynchronously
    • Get an order
    • Get order metrics for evergreen subscription
    • Get all orders
    • Get orders by subscription owner
    • Get orders by subscription number
    • Get orders by invoice owner
  • •  

[Jing]

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

• 2020-11-13

  Doc Updates

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

• • Updated the request sample of the "Create custom object definition" operation.

  • Made the following updates to the “Create credit memo from invoice” and “Create debit memo from invoice” operations:

    • In the request body of each operation, added more details about the invoiceId field and clarified the purpose of this field.
    • Correctedthe items > taxMode field in the request sample of each operation.
  •  

[Jing]

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

• 2020-11-27

  Doc Updates

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

• • In the request body of each of the following operations, added more details about the ProductRatePlanChargeTierData > ProductRatePlanChargeTier field:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  •  
•