Happy Business Starts Here

Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-11-06

 

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 261, November 2019.

 

  • Data Queries - In the request body of the “Submit data query” operation, added the useIndexJoin field.

  • Orders - Made the following updates:

    • In the request body of the "Create order" operation, changed the behaviors of the following fields for order actions that now support pending orders:

      • subscriptions > orderActions > type
      • subscriptions > orderActions > triggerDates
      • subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate
      • subscriptions > orderActions > addProduct > chargeOverrides > startDate > specificTriggerDate
      • subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > specificTriggerDate
    • In the response body of the "Get an order" and "Get order metrics for evergreen subscription" operations, changed the behaviors of the following fields for order actions that now support pending orders:

      • order > subscriptions > orderActions > type
      • order > subscriptions > orderActions > triggerDates
      • order > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate
      • order > subscriptions > orderActions > addProduct > chargeOverrides > startDate > specificTriggerDate
      • order > subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > specificTriggerDate
    • In the response body of the following operations:

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

      changed the behaviors of the following fields for order actions that now support pending orders:

      • orders > subscriptions > orderActions > type
      • orders > subscriptions > orderActions > triggerDates
      • orders > subscriptions > orderActions > createSubscription > subscribeToRatePlans > chargeOverrides > startDate > specificTriggerDate
      • orders > subscriptions > orderActions > addProduct > chargeOverrides > startDate > specificTriggerDate
      • orders > subscriptions > orderActions > updateProduct > chargeUpdates > effectiveDate > specificTriggerDate
    • Changed the behavior of the "Update order action trigger dates" operation.

    • In the request body of following operations, changed the behaviors of the subscriptions > orderActions > termsAndConditions > lastTerm > startDate field by noting that you can now change the term start date of a renewed subscription through a T&Cs order action:

      • Preview order
      • Create order"
    • In the following operations, removed the limitations on Orders for the Single Transaction Subscribe and Amend functionality:

      • Preview subscription
      • Create subscription
      • Update subscription
      • Renew subscription
      • Cancel subscription
      • Resume subscription
      • Suspend subscription
      • Create account
      • CRUD: Update amendment
      • CRUD: Delete Subscription
      • CRUD: Update rate plan charge
      • CRUD: Update Subscription
      • CRUD: Delete Subscription
    • In the following actions, removed the limitations on Orders for the Single Transaction Subscribe and Amend functionality:

      • Subscribe
      • Amend
      • Create
      • Query
      • Update

 

Doc Updates

 

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

 

  • In the response body of the "CRUD: Get invoice" operation, corrected the description of the following fields:

    • IncludesOneTime
    • IncludesRecurring
    • IncludesUsage
  • Moved the following operations to the Billing Documents section from the Accounts section.

    • Generate billing documents by account
    • Create job to hard delete billing document files
    • Get job of hard deleting billing document files
  • In the "Get billing documents" operation, updated the request sample.

  • In the 200 response body of the “Get all custom object definitions” operation, made the following field updates:

    • Changed id to Id
    • Changed createdById to CreatedById
    • Changed createdDate to CreatedDate
    • Changed updatedById to UpdatedById
    • Changed updatedDate to UpdatedDate
    • Changed schema > properties > id to schema > properties > Id
    • Changed schema > properties > createdById to schema > properties > CreatedById
    • Changed schema > properties > createdDate to schema > properties > CreatedDate
    • Changed schema > properties > updatedById to schema > properties > UpdatedById
    • Changed schema > properties > updatedDate to schema > properties > UpdatedDate
  • In the 200 response body of the “Create custom object definition” and “Get custom object definition” operations, made the following field updates:

    • Changed id to Id
    • Changed createdById to CreatedById
    • Changed createdDate to CreatedDate
    • Changed updatedById to UpdatedById
    • Changed updatedDate to UpdatedDate
    • Changed schema > properties > id to schema > properties > Id
    • Changed schema > properties > createdById to schema > properties > CreatedById
    • Changed schema > properties > createdDate to schema > properties > CreatedDate
    • Changed schema > properties > updatedById to schema > properties > UpdatedById
    • Changed schema > properties > updatedDate to schema > properties > UpdatedDate
  • In the 200 response body of the “Create custom object records” and “Query custom object records” operations, made the following field updates:

    • Changed records > id to records > Id
    • Changed records > createdById to records > CreatedById
    • Changed records > createdDate to records > CreatedDate
    • Changed records > updatedById to records > UpdatedById
    • Changed records > updatedDate to records > UpdatedDate
  • In the 200 response body of the following operations

    • Get custom object record
    • Update custom object record
    • Update individual fields in a custom object record

    made the following field updates:

    • Changed id to Id
    • Changed createdById to CreatedById
    • Changed createdDate to CreatedDate
    • Changed updatedById to UpdatedById
    • Changed updatedDate to UpdatedDate
  • In the response body of the following operations, changed the order (or orders) > subscriptions > orderActions > termsAndConditions > lastTerm field to order (or orders) > subscriptions > orderActions > termsAndConditions > initialTerm:

    • Get an order
    • 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" operation, updated the descriptions of the following fields to note that hyphens must not be used when you set the credit card number:

    • newAccount > creditCard > cardNumber
    • subscriptions > orderActions > createSubscription > newSubscriptionOwnerAccount > creditCard > cardNumber
  • In the source YAML file, duplicated the TriggerParams reference object as the following new reference objects:

    • A reference object called PreviewOrderTriggerParams that is used in the request body of the “Preview order” operation.
    • A reference object called CreateOrderTriggerParams that is used in the request body of the “Create order” operation.
Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-11-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 262, November 2019.

 

  • Workflows - Added an operation called "Delete a workflow by ID".

Doc Updates

 

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

 

  • In the description of the "Create custom object definition" operation, updated the limitation of the Text field.
  • In the 200 response body of the "Create custom object records" operation, updated the description of the unprocessedRecords field.
Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-11-21

 

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 custom object definition” operation
    • Removed the type field
    • Updated the description of the relationships > fields field.
  • In the following operations, renamed the path parameter from type to object:
    • Get custom object definition
    • Delete custom object definition
    • Create custom object records
    • Query custom object records
    • Get custom object record
    • Update custom object record
    • Update individual fields in a custom object record
    • Delete custom object record
    • Update or delete custom object records as a batch
  • Updated the limitations in the description of the “Update custom object definition” operation.
  • In the "Query usage records" operation, removed unitOfMeasure from the description of the filters query parameter.
  • In request body of the "Submit data query" operation, changed the enum value JSONL to JSON for the outputFormat field.
Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-12-04

 

API Updates

 

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

 

The following API updates are available as of Zuora Billing Release 263, December 2019.

 

  • Orders - Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations.

  • Credit Memos - Made the following updates:

    • Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations.
    • Changed the behavior of the “Create credit memo from charge” operation. When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.
  • Debit Memos - Changed the behavior of the “Create debit memo from charge” operation. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.

 

Doc Updates

 

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

  • In the response body of the "Subscribe" action, corrected the nested fields of the InvoiceData > InvoiceItem field.
  • In the response body of the "Amend" action, corrected the nested fields of the results > InvoiceDatas > InvoiceItem field.
  • In the response body of the "Amend" action, corrected the InvoiceDatas > InvoiceItem nested fields.

  • In the source YAML file, duplicated the InvoiceItem reference object as the following new reference objects:

    • A reference object called ActionSubscribeInvoiceItem that is used in the response body of the “Subscribe” action.
    • A reference object called ActionAmendInvoiceItem that is used in the response body of the “Amend” action.
  • In the source YAML file, duplicated the InvoiceData reference object as the following new reference objects:

    • A reference object called ActionSubscribeInvoiceData that is used in the response body of the “Subscribe” action.
    • A reference object called ActionAmendInvoiceData that is used in the response body of the “Amend” action.
  • In the description of the “Query custom object records” operation, added the limitations of this operation.

  • In the description of the “List all settings” operation, added links pointing to the tutorials of Settings API in the Knowledge Center.

Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-12-04

 

API Updates

 

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

 

The following API updates are available as of Zuora Billing Release 263, December 2019.

 

  • Orders - Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations.

  • Credit Memos - Made the following updates:

    • Deprecated the "Request breakdown of invoice items by order" and "Get breakdown of invoice by order" operations.
    • Changed the behavior of the “Create credit memo from charge” operation. When credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.
  • Debit Memos - Changed the behavior of the “Create debit memo from charge” operation. When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.

 

Doc Updates

 

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

  • In the response body of the "Subscribe" action, corrected the nested fields of the InvoiceData > InvoiceItem field.
  • In the response body of the "Amend" action, corrected the nested fields of the results > InvoiceDatas > InvoiceItem field.
  • In the source YAML file, duplicated the InvoiceItem reference object as the following new reference objects:

    • A reference object called ActionSubscribeInvoiceItem that is used in the response body of the “Subscribe” action.
    • A reference object called ActionAmendInvoiceItem that is used in the response body of the “Amend” action.
  • In the source YAML file, duplicated the InvoiceData reference object as the following new reference objects:

    • A reference object called ActionSubscribeInvoiceData that is used in the response body of the “Subscribe” action.
    • A reference object called ActionAmendInvoiceData that is used in the response body of the “Amend” action.
  • In the description of the “Query custom object records” operation, added the limitations of this operation.

  • In the description of the “List all settings” operation, added links pointing to the tutorials of Settings API in the Knowledge Center.

Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-12-12

 

API Updates

 

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

 

The following API updates are available as of Zuora Billing Release 264, December 2019.

 

  • Workflows - Added an operation called "Get workflow task usage".

 

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 credit memo items" operation, added the following missing nested fields to the items field:

    • appliedToItemId
    • processingType
    • quantity
    • unitOfMeasure
    • unitPrice
  • In the response body of the "Get credit memo item" operation, added the following missing fields:

    • appliedToItemId
    • processingType
    • quantity
    • unitOfMeasure
    • unitPrice
  • In the request body of the "Create payment" operation, added the following missing fields:

    • authTransactionId
    • gatewayOrderId
  • Updated the description of the "Create authorization" operation for better clarity.

  • Added a note to the description of the “Delete custom object record” operation.

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

  • In the following operations, removed the previewChargeMetricsResponse field from the response body:

    • Preview subscription
    • Update subscription
  • In the description of the "Generate RSA signature" operation, added a note to highlight that you should secure your Payment Pages from being accessed by fraudulent users before issuing client-side digital signatures and tokens.

Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-12-19

 

Doc Updates

 

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

 

  • In the request body of the following operations, added the missing quantity nested field to the charges field.

    • Create credit memo from charge
    • Create debit memo from charge
  • In the request body of the following operations, added the missing quantity nested field to the items field.

    • Update credit memo
    • Update debit memo
  • In the response body of the "Get debit memo items" operation, added the following missing nested fields to the items field:

    • quantity
    • unitOfMeasure
    • unitPrice
  • In the response body of the "Get debit memo item" operation, added the following missing fields:

    • quantity
    • unitOfMeasure
    • unitPrice
  • Added the 400 response for the "Create custom object records" operation.

  • Removed the Limited Availability notes from the descriptions of the following operations:

    • List all settings
    • Submit multiple settings requests as a batch
Highlighted
Zuora Documentation

Re: API Changelog

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!

 

2019-12-27

 

Doc Updates

 

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

 

  • In the request body of the "Amend" action, corrected the nested fields of the requests > Amendments > RatePlanData > SubscriptionProductFeatureList > SubscriptionProductFeature field.

  • In the source YAML file, duplicated the SubscriptionProductFeature reference object as a new reference object called ActionAmendSubscriptionProductFeature, which is used in the request body of the “Amend” action.

  • Added the In Development notes to the descriptions of the following operations:

    • List all settings
    • Submit multiple settings requests as a batch
  • Changed the Limited Availability notes to In Development notes in the descriptions of the following operations:

    • Get all namespaces
    • Get namespace
    • Get all custom object definitions in namespace
    • Create custom object definition
    • Get custom object definition
    • Delete custom object definition
    • Update custom object definition
    • Create custom object records
    • Query custom object records
    • Get custom object record
    • Update custom object record
    • Update individual fields in a custom object record
    • Delete custom object record
    • Update or delete custom object records as a batch
Highlighted
Zuora Documentation

Re: API Changelog

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-01-16

 

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 266, January 2020.

 

  • Invoices - Made the following updates:

    • In the request body of the following operations, added the quantity nested field to the items field:
      • Create credit memo from invoice
      • Create debit memo from invoice
    • In the request body of the "Create debit memo from invoice" operation, fixed the issue that the autoPay field could not be set to false.
  • RevPro Integration - Added a resource called "RevPro Integration", with the following operation:

    • Update an accounting code

 

Doc Updates

 

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

 

  • Corrected the response sample of the "Get taxation items of invoice item" operation.

  • Added the link of the Postman collection for Custom Objects API to the descriptions of the following sections:

    • Custom object definitions
    • Custom object records
  • Added the link of the Postman collection for Settings API to the description of the “Settings” section.

Highlighted
Zuora Documentation

Re: API Changelog

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-02-06

 

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 267, February 2020.

 

  • Hosted Pages - In the "Return hosted pages" operation, made the following updates:

    • Removed the pageSize query parameter.
    • Removed the nextPage field from the response body.
  • Data Queries - In the "Submit data query" operation, added a field called readDeleted to the request body.

 

Doc Updates

 

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

 

  • In the request body of the following operations, corrected the value format of the UpToPeriodsType field:
    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • In the request body of the "CRUD: Get product rate plan charge" operation, corrected the value format of the UpToPeriodsType field.
  • In the description of the "Create subscription" operation, noted that the operation does not support creating a pending subscription.
  • In the “Authentication” section, updated the note in the “Generate a Token” subsection.