Order Action Data Source

Last updated
Save as PDF

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.

Data Source Details

The following base and related (joint) objects are available for an order action.

Base Object Description

The following table provides descriptions for the base object.

Object Description

Order Action

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

Related Object Description

The following table provides descriptions for related objects.

Object	Description
Account	The customer account information. Note this is the Subscription Owner account.
Add Rate Plan	Refers to the rate plan or pricing plan information associated with the Add Product order action. For complete information about ChangePlan (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. 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
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.
Order	The order you want to view the order action information for.
Order Action Bill To	The bill to contact that is specified at subscription level during creating order action: CreateSubscription, Renewal or TermsAndConditions order action.
Parent Account	Refers to the parent account associated with the customer account, if applicable.
Remove Rate Plan	Refers to the rate plan or pricing plan information associated with the Remove Product order action. For complete information about ChangePlan (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. 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
Sold To	The contact associated with the account to whom your product or service is sold.
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 Bill To	The bill-to contact of a subscription.
Subscription Bill To Snapshot	A copy of the bill-to contact information of a subscription.
Subscription Owner Account	The subscription owner of an order.
Subscription Owner Account Bill To	The bill-to contact of an order's subscription owner.
Subscription Owner Account Sold To	The sold-to contact of an order's subscription owner.
Subscription Status History	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.
Subscription Version Amendment	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 tenants, the Subscription Version Amendment object is not available; you should use the Order object instead. If you are in the 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.
Update Rate Plan	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