Skip to main content

Order Action Data Source

Zuora

Order Action Data Source

This feature is only available if you have the Order Metrics feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on Orders Harmonization. Join the Orders Harmonization Community group for more information. You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions. 

You can access all the new capabilities in the Sandbox environment starting August 31, 2020. The Production deployment is September 10, 2020.

Use this data source to report on the actions to be applied to the subscription in a given order. Examples of order action types would be New Subscription, Update Product, New Product, etc. See Order Actions for more information.

The following objects are available in the data source.

Object Description
Order Action

Contains the following fields:

  • Auto Renew
  • Cancellation Effective Date
  • Cancellation Policy
  • Contract Effective Date
  • Created By ID
  • Created Date
  • Current Term
  • Current Term Period Type
  • Customer Acceptance Date
  • ID
  • Renewal Setting
  • Renewal Term
  • Renewal Term Period Type
  • Resume Date
  • Service Activation Date
  • Suspend Date
  • Term Start Date
  • Term Type
  • Type
  • Updated By ID
  • Updated Date
  • Custom Fields

Subscription

The subscription to which the rate plan is associated. Contains the following fields:

  • Auto Renew
  • Cancelled Date
  • Contract Acceptance Date
  • Contract Effective Date
  • Cpq Bundle Json ID
  • Created By ID
  • Created Date
  • Creator Account ID
  • Creator Invoice Owner ID
  • Current Term
  • Current Term Period Type
  • ID
  • Initial Term
  • Initial Term Period Type
  • Invoice Owner ID
  • Invoice Separate
  • Name
  • Notes
  • Opportunity Close Date
  • Opportunity Name
  • Original Created Date
  • Original ID
  • Previous Subscription ID
  • Quote Business Type
  • Quote Number
  • Quote Type
  • Renewal Setting
  • Renewal Term
  • Renewal Term Period Type
  • Service Activation Date
  • Status
  • Subscription End Date
  • Subscription Start Date
  • Term End Date
  • Term Start Date
  • Term Type
  • Updated By ID
  • Updated Date
  • Version
Subscription Version Amendment

The amendment that is responsible for creating the particular subscription version. This amendment corresponds directly to the Order object. If you have the Orders feature enabled, the Subscription Version Amendment object is not available; you should use the Order object instead.

Order

The order you want to view the order action information for.

Account

The customer account information. Note this is the Invoice Owner account.

Bill To 

The contact associated with the account to whom your product or service is billed.

Default Payment Method

The default payment method used to make payments.

Parent Account

Refers to the parent account associated with the customer account, if applicable.

Sold To

The contact associated with the account to whom your product or service is sold.