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