Happy Business Starts Here

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

 

Doc Updates

 

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

 

  • Added the missing Zuora-Entity-Ids request header in the following operations:

    • Get revenue recognition rule by product rate plan charge
    • Create revenue schedule for credit memo item (manual distribution)
    • Get revenue schedule by credit memo item ID
    • Create revenue schedule for credit memo item (distribute by date range)
    • Create revenue schedule for debit memo item (manual distribution)
    • Get revenue schedule by debit memo item ID
    • Create revenue schedule for debit memo item (distribute by date range)
    • Get all revenue schedules of product charge by charge ID and billing account ID
  • In the request body of the “Create stored credential profile” operation, added the missing networkTransactionId field.

  • In the request body of the "CRUD: Update account" operation, corrected the descriptions of the following fields:

    • Currency
    • Status
  • In the response body of the "CRUD: Get account" operation, corrected the descriptions of the Status field.

  • In the request body of the "CRUD: Create account" operation, corrected the descriptions of the Status field.

  • In the Zuora Object Model section, added more information about the differnces between the BillingRun object and BillRun object.

  • In the response body of the "CRUD: Get payment method" operation, updated the description of the Active and PaymentMethodStatus fields to distinguish them.

  • In the request body of the "CRUD: Update payment method" operation, updated the description of the PaymentMethodStatus field for better clarity.

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-08-08

 

API Updates

 

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

 

The following API updates are available as of Zuora Release 253, July 2019.

 

  • Workflows - Added a new resource called “Workflows”, with the “Get workflows” operation for retrieving workflows on a tenant. Filters can be used to retrieve specific workflows. If no filters are specified, all workflows will be returned.

 

Doc Updates

 

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

 

  • Added more information about the REST endpoint base UL of the US Production Copy Environment.
  • In the "Create payment method" operation, corrected the names of the following fields:

    • bankAccountName
    • bankAccountNumber
    • bankAccountType
    • bankName

    Previously, they were incorrectly documented as:

    • achBankAccountName
    • achBankAccountNumber
    • achBankAccountType
    • achBankName
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-08-15

 

Doc Updates

 

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

 

  • In the "Amend" action, added the following missing fields to the requests > Amendments field in the request body:

    • ResumeDate
    • SuspendDate
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-08-28

 

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 255, August 2019.

  • Credit Memos - Made the following updates:

    • In the response body of the following operations, added the taxStatus and taxMessage fields:
      • Create credit memo from charge
      • Get credit memo
      • Update credit memo
      • Apply credit memo
      • Unapply credit memo
      • Cancel credit memo
      • Post credit memo
      • Unpost credit memo
    • In the response body of the "Get credit memos" operation, added the following fields to the creditmemos field:
      • taxStatus
      • taxMessage
  • Debit Memos - Made the following updates:

    • In the request body of the "Create debit memo from charge" operation:
      • Added the accountNumber field.
      • Changed the behavior of accountId field. This field is now conditionally required. You must specify accountNumber, accountId, or both in the request body.
    • In the response body of the following operations, added the taxStatus and taxMessage fields:
      • Create debit memo from charge
      • Get debit memo
      • Update debit memo
      • Cancel debit memo
      • Post debit memo
      • Unpost debit memo
    • In the response body of the "Get debit memos" operation, added the following fields to the debitmemos field:
      • taxStatus
      • taxMessage
  • Invoices - In the response body of the following operations, added the taxStatus and taxMessage fields:

    • Create credit memo from invoice
    • Create debit memo from invoice

 

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 ProductRatePlanChargeTierData field and its nested fields:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • In the request sample of the following operations, removed the ProductRatePlanChargeTierData > ProductRatePlanChargeTier > Active field:

    • CRUD: Create product rate plan charge
    • CRUD: Update product rate plan charge
  • Added the missing “CRUD: Update ProductRatePlanChargeTier” operation.

  • In the “Get credit card payment methods for account” operation, updated the description to clarify that the response does not include effective details for ACH payment methods if this operation is used to get ACH payment methods.

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-09-11

 

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 256, September 2019.

 

  • Data Queries - In the request body of the "Submit data query" operation, made the following updates:
    • Added TSV and DSV to the enum values of the outputFormat field.
    • Added the columnSeparator field. Use this field to pass in your custom delimiter when you set the outputFormat field to DSV.

 

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 "Submit data query" operation, added descriptions for the enum values of the data > queryStatus field.

  • Added the missing "CRUD: Update rate plan charge" operation.

  • In the "CRUD: Update invoice" operation, corrected the request example.

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-09-19

 

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 257, September 2019.

 

  • Credit Memos - Made the following updates:

    • In the request body of the "Create credit memo from charge" operation:
      • Changed the behavior of the charges > chargeId field. The availability of this field now depends on the zuora-version request header.
      • Added the produceRatePlanChargeId nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later.
      • Changed the behavior of the charges > comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later.
    • In the response body of the "Get credit memo items" operation:
      • Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later.
    • In the response body of the "Get credit memo item" operation:
      • Changed the behavior of the comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description field. This field is only available if you set the zuora-version request header to 257.0 or later.
  • Debit Memos - Made the following updates:

    • In the request body of the "Create debit memo from charge" operation:
      • Changed the behavior of the charges > chargeId field. The availability of this field now depends on the zuora-version request header.
      • Added the produceRatePlanChargeId nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later.
      • Changed the behavior of the charges > comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description nested field to the charges field. The new field is only available if you set the zuora-version request header to 257.0 or later.
    • In the response body of the "Get debit memo items" operation:
      • Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later.
    • In the response body of the "Get debit memo item" operation:
      • Changed the behavior of the comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description field. This field is only available if you set the zuora-version request header to 257.0 or later.
  • Invoices - Made the following updates:

    • In the request body of the "Create credit memo from invoice" operation:
      • Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later.
    • In the request body of the "Create debit memo from invoice" operation:
      • Changed the behavior of the items > comment field. The availability of this field now depends on the zuora-version request header.
      • Added the description nested field to the items field. The new field is only available if you set the zuora-version request header to 257.0 or later.

 

Doc Updates

 

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

 

  • Moved the “Get the revenue automation start date” operation from the "Settings" section to the “Revenue rules” section.

  • Removed the deprecated "Get billing information for order" operation.

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-10-10

 

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 258, October 2019.

 

  • Custom Object DefinitionsAdded a resource called "Custom Object Definitions", with 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
  • Custom Object RecordsAdded a resource called "Custom Object Records", with the following operations:
    • 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
  • SettingsAdded a resource called "Settings", with the following operations:
    • List all settings
    • Submit multiple settings requests as a batch
  • Data Queries - In the request body of the "Submit data query" operation, changed the JSON value of the outputFormat field to JSONL

 

Doc Updates

 

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

 

  • In the request body of the "Preview order" operation, added descriptions for the subscriptions > orderActions > updateProduct > chargeUpdates field.

  • In the request body of the "Amend" action, updated the description of the requests > Amendments > Type field.

  • In the request body of the "Subscribe" action, updated the description of the subscribes > Account > DefaultPaymentMethodId field.

  • In the "Create order" operation, added the missing query parameter returnIds and the following missing response fields:

    • orderId
    • accountId
    • subscriptionIds
    • subscriptions > subscriptionId
    • invoiceIds
    • creditMemoIds
    • paymentId
  • In the following operations, corrected the data type to number for all fields that previously had the string <decimal> data type.

    • Preview subscription
    • Create subscription
    • Get subscriptions by account
    • Update subscription
    • Get subscriptions by key
    • Get subscriptions by key and version
    • Renew subscription
    • Cancel subscription
    • Resume subscription
    • Suspend subscription
  • In the "Create revenue schedule on subscription charge" operation, updated the description to clarify that a maximum of 3,000 revenue schedules can be created for one subscription charge.

  • In the "Get custom foreign currency exchange rates" operation, updated the request sample and the response sample.

  • In the description of the "Generate an OAuth token" operation, added more details about the rate limit of the operation.

  • In the Introduction section, added links to Zuora Collect API Reference and RevPro API Reference.

  • Added a section called Usage (With Active Rating), containing the following operations. Previously, these operations were documented on a separate page.

    • Create usage records
    • Update usage record
    • Get usage record
    • Delete usage record
    • Query usage records
    • Query usage records in stream
    • Import usage file
    • Get usage imports
    • Get details of usage import
    • Get status of usage import
    • Download usage import file
    • Download usage import failure file
    • Download usage file template
    • Get rating results by account
    • Get rating results by subscription
    • Get rating results by charge
    • Get rated usage by account
    • Get rated usage by subscription
    • Get rated usage by charge
    • Get Usage custom field definition
    • Set schema of Usage custom field definition
    • Delete schema of Usage custom field definition
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-10-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 259, October 2019.

  • Subscriptions - Added the following fields to the request body of the "Create subscription" operation:

    • gatewayId
    • paymentMethodId
  • Workflows - Added the following operations:

    • Run a workflow
    • Import a workflow
    • Export a workflow
    • Get tasks
    • Get a task by ID
    • Update tasks in batch
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-10-24

 

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 260, October 2019.

 

  • Payment Methods - In the request body of the "Cancel authorization" operation, made the following updates:

    • Added the optional paymentGatewayId field.
    • Updated the accountId and accountNumber fields from required to optional, and clarified that they are not required if Ingenico ePayments gateway is used.
  • Workflows - Added the following operation:

    • Get a workflow by ID

 

Doc Updates

 

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

 

  • In the “Get product catalog” operation, added the page query parameter.
  • In the “Get product rate plans” operation, added the page query parameter.
  • In the “Usage (with Active Rating)” section, clarified that if a 500 or 502 error occurs when you call any of the Usage (with Active Rating) operations, the first troubleshooting step is to retry the call.
  • In the description of the “Create usage records” operation, clarified that the account to create usage records for must have a corresponding usage-based rate plan charge.
  • In the description of the "Run a workflow" operation, added that input parameters can be included in the request body and provided a link to a Knowledge Center article that explains how to define input parameters for a workflow.
  • In the description of the "Scrub payment method" operation, clarified that a payment method must be scrubbed before anonymizing its associated account and contact.
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-01

 

Doc Updates

 

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

 

  • Removed the “Get all namespaces” and “Get namespace” operations from the Custom Object Definitions section.

  • Renamed the “Get all custom object definitions in namespace” operation to “Get all custom object definitions”.

  • Replaced the {namespace} path parameter with default in the endpoints of the following operations:

    • Get all custom object definitions
    • Create custom object definition
    • 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
  • In the request body of the “Create custom object definition” operation, changed the following fields to required:

    • properties >property name * > type

    • properties >property name * > label

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

    • Changed definitions >property name * > relationships to definitions >property name * > schema > relationships.

    • Changed definitions >property name * > required to definitions >property name * > schema > required.
  • In the 200 response body of the "Create custom object" and "Get custom object definition" operations, made the following field updates:

    • Changed relationships to schema > relationships.
    • Changed required to schema > required
  • In the “Update custom object definition” operation, updated the limitations in the operation description.

  • In the "Create custom object definition" operation, added the limitation for custom fields of Text type.

  • In the request and 200 response body of the “Update custom object definition” operation, added the following missing fields:

    • actions > label
    • actions > field > definition > default
    • actions > field > definition > description
  • In the “Update or delete custom object records as a batch” operation, made the following updates:

    • Changed the 200 response sample from a delete batch action response to an update batch action response.
    • Updated the description of the result > unprocessedIds field in the response body. 
  • Updated the description of the note in all the operations that are related to the Active Rating feature.