> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Order Action data source

> Data source to report on the actions to be applied to the subscription in a given order.

Data source to report on the actions to be applied to the subscription in a given order.

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.

## Accessing the data source

​ Navigation: **Reporting** > **Data Sources** and select **Order Action** as the data source.

## Base object description

The following table provides descriptions for the base object.

<table>
  <tr>
    <td>
      Order Action
    </td>

    <td>
      Contains the following fields:

      * Auto Generated - Customers using Order Harmonization can use this field to determine whether an order action is automatically generated by the system or created through the [Create an order](https://www.zuora.com/developer/api-references/api/operation/POST_Order) operation(or Orders UI). Possible values for the field are:

        * `TRUE`: The order action is automatically generated by the system as a result of a subscription or amendment created through the Subscribe and Amend APIs and UI.
        * `FALSE`: The order action is created through the "Create an order" operation or Orders UI.
      * Auto Renew
      * Cancellation Effective Date - When the Cancellation Policy field is set to `SpecificDate`, you need to use this field to set the specific cancellation date. Otherwise, leave this field empty.
      * Cancellation Policy
      * Clearing Existing Bill To Contact
      * Clearing Existing Invoice Template
      * Clearing Existing Payment Term
      * Clearing Existing Sequence Set
      * Contract Effective Date
      * Created By ID
      * Created Date
      * Current Term
      * Current Term Period Type
      * Customer Acceptance Date
      * ID
      * Invoice Group Number
      * Invoice Template ID
      * Payment Term
      * Renewal Setting
      * Renewal Term
      * Renewal Term Period Type
      * Resume Date
      * Sequence
      * Sequence Set ID
      * Service Activation Date
      * Status
      * Suspend Date
      * Sub Type
      * Term Start Date
      * Term Type
      * Type
      * Updated By ID
      * Updated Date
      * Custom Fields
    </td>
  </tr>
</table>

## Related object description

The following table provides descriptions for related objects.

<table>
  <tr>
    <th>
      Object
    </th>

    <th>
      Description
    </th>
  </tr>

  <tr>
    <td>
      Account
    </td>

    <td>
      The customer account information. Note this is the Subscription Owner account.
    </td>
  </tr>

  <tr>
    <td>
      Add Rate Plan
    </td>

    <td>
      Refers to the rate plan or pricing plan information associated with the Add Product order action.

      For complete information about [ChangePlan](https://www.zuora.com/developer/api-references/api/operation/POST_Order) (that is, removing the old rate plan and adding a new one), you can retrieve the information in one of the following methods:

      * View the "Remove Rate Plan" joined object and this joined object.
      * View the "Order Action" object with the Type field specified as ChangePlan.

      Note that the change plan type of order action and subscription amendment is currently not supported for [Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).

      Contains the following fields:

      * Amendment Type: Note that a filter on this field using the unequal operator cannot return those Rate Plan records with a blank Amendment Type field.
      * Created By ID
      * Created Date
      * Externally Managed Plan ID: a text field. This field indicates the unique identifier of a rate plan purchased on a third-party store.
      * ID
      * Invoice Owner ID: the invoice owner ID of the subscription that contains the rate plan
      * Name
      * Subscription Owner ID: the subscription owner ID of the subscription that contains the rate plan
      * Updated By ID
      * Updated Date
    </td>
  </tr>

  <tr>
    <td>
      Bill To
    </td>

    <td>
      The contact associated with the account to whom your product or service is billed.
    </td>
  </tr>

  <tr>
    <td>
      Default Payment Method
    </td>

    <td>
      The default payment method used to make payments.
    </td>
  </tr>

  <tr>
    <td>
      Order
    </td>

    <td>
      The order you want to view the order action information for.
    </td>
  </tr>

  <tr>
    <td>
      Order Action Bill To
    </td>

    <td>
      The bill to contact that is specified at subscription level during creating order action: CreateSubscription, Renewal or TermsAndConditions order action.
    </td>
  </tr>

  <tr>
    <td>
      Parent Account
    </td>

    <td>
      Refers to the parent account associated with the customer account, if applicable.
    </td>
  </tr>

  <tr>
    <td>
      Remove Rate Plan
    </td>

    <td>
      Refers to the rate plan or pricing plan information associated with the Remove Product order action.

      For complete information about [ChangePlan](https://www.zuora.com/developer/api-references/api/operation/POST_Order) (that is, removing the old rate plan and adding a new one), you can retrieve the information in one of the following methods:

      * View this joined object and the "Add Rate Plan" joined object.
      * View the "Order Action" object with the Type field specified as ChangePlan.

      Note that the change plan type of order action and subscription amendment is currently not supported for [Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).

      Contains the following fields:

      * Amendment Type: Note that a filter on this field using the unequal operator cannot return those Rate Plan records with a blank Amendment Type field.
      * Created By ID
      * Created Date
      * Externally Managed Plan ID: a text field. This field indicates the unique identifier of a rate plan purchased on a third-party store.
      * ID
      * Invoice Owner ID: the invoice owner ID of the subscription that contains the rate plan
      * Name
      * Subscription Owner ID: the subscription owner ID of the subscription that contains the rate plan
      * Updated By ID
      * Updated Date
    </td>
  </tr>

  <tr>
    <td>
      Sold To
    </td>

    <td>
      The contact associated with the account to whom your product or service is sold.
    </td>
  </tr>

  <tr>
    <td>
      Subscription
    </td>

    <td>
      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
    </td>
  </tr>

  <tr>
    <td>
      Subscription Bill To
    </td>

    <td>
      The bill-to contact of a subscription.
    </td>
  </tr>

  <tr>
    <td>
      Subscription Bill To Snapshot
    </td>

    <td>
      A copy of the bill-to contact information of a subscription.
    </td>
  </tr>

  <tr>
    <td>
      Subscription Owner Account
    </td>

    <td>
      The subscription owner of an order.
    </td>
  </tr>

  <tr>
    <td>
      Subscription Owner Account Bill To
    </td>

    <td>
      The bill-to contact of an order's subscription owner.
    </td>
  </tr>

  <tr>
    <td>
      Subscription Owner Account Sold To
    </td>

    <td>
      The sold-to contact of an order's subscription owner.
    </td>
  </tr>

  <tr>
    <td>
      Subscription Status History
    </td>

    <td>
      The status history information of a subscription. Contains the following fields:

      * **Created By ID** - The ID of the user who creates the subscription.
      * **Created Date** - The date when the subscription is created.
      * **End Date** - The latest date that the status ends.
      * **ID** - The unique identifier of the subscription.
      * **Sort Order** - The chronological order of the subscription statuses.
      * **Start Date** - The effective start date of the status history.
      * **Status** - The status of the subscription.
      * **Subscription Number** - The subscription number that uniquely identifies each subscription.
      * **Updated By ID** - The ID of the user who last updates the subscription.
      * **Updated Date** - The date when the subscription is last updated.
    </td>
  </tr>

  <tr>
    <td>
      Subscription Version Amendment
    </td>

    <td>
      The amendment that is responsible for creating the particular subscription version.

      If you have the Orders feature enabled, consider the following depending on different tenant types:

      * If you are in the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_accounts%2C_subscriptions%2C_and_non-subscription_transactions/Manage_subscription_transactions/Orders) tenants, the Subscription Version Amendment object is not available; you should use the Order object instead.
      * If you are in the [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Manage_accounts%2C_subscriptions%2C_and_non-subscription_transactions/Manage_subscription_transactions/Orders_Harmonization/A_Overview_of_Orders_Harmonization) tenants, and the subscription version was created through an order, the Subscription Version Amendment object is available. However, if the order has multiple order actions, since the type of amendment is a composite type, the exported data does not include any change detail.
    </td>
  </tr>

  <tr>
    <td>
      Update Rate Plan
    </td>

    <td>
      Refers to the rate plan or pricing plan information associated with the Update Product order action.

      Contains the following fields:

      * Amendment Type: Note that a filter on this field using the unequal operator cannot return those Rate Plan records with a blank Amendment Type field.
      * Created By ID
      * Created Date
      * Externally Managed Plan ID: a text field. This field indicates the unique identifier of a rate plan purchased on a third-party store.
      * ID
      * Invoice Owner ID: the invoice owner ID of the subscription that contains the rate plan
      * Name
      * Subscription Owner ID: the subscription owner ID of the subscription that contains the rate plan
      * Updated By ID
      * Updated Date
    </td>
  </tr>
</table>