View subscription change history
The process for viewing subscription change histories varies depending on whether you have the Single Version Subscription feature enabled in your tenant:
For more information, see Single Version Subscription.
View Versioned Subscription Change History
As a change is made to a subscription (such as an Add product amendment and a Renew subscription order action), a new version of the subscription is created. The corresponding order action or amendment type of each subscription version indicates the change made to the subscription.
You can view the change history of a subscription on the subscription detail page.
You can also query the Subscription Status History data source, see Query data through Subscription Status History data source.
To view the change history of a subscription:
- Navigate to Customers > Subscriptions in the left-hand navigation section.
- Select the subscription that you want to view the change history.
- In the Subscription detail screen, scroll to the Subscription change history area. You can see a table that lists the detailed change information for each version of the subscription.
Each row in the change history table stands for a subscription version. Based on the mode of your tenant: Orders, Subscribe/Amend (S/A), or Orders Harmonization (Orders and S/A co-existent), the table can contain corresponding columns that indicate the detailed change information.
Orders Tenants
For an Orders tenant, the Subscription change history table is like below:
It contains the following columns:
- Version: Identifies a certain version of the subscription.
- Order Number: Identifies the order that contributes to this version of the subscription. This column is present in Orders tenants or co-existent tenants.
- Order Action: The order actions that have impacted the subscription and taken place in a particular order. If multiple order actions are present in this column, you can click the plus icon (+) in the Version column to display a list of the order actions. At most five order actions can be displayed.
- Order Details: The detailed change information tagged for each order action in the order.
- Created By
- Created On
- Order Date
- Contract Effective
- Service Activation: This column is present if Zuora is configured to require service activation.
- Customer Acceptance: This column is present if Zuora is configured to require customer acceptance.
Orders Harmonization Tenants
For an Orders Harmonization (Orders and S/A co-existent) tenant, the table is like below:
It contains the following columns:
- Version: Identifies a certain version of the subscription.
- Order Number: Identifies the order that contributes to this version of the subscription. This column is present in Orders tenants or co-existent tenants.
- Amendment Number: Identifies the amendment that contributes to this version of the subscription. This column is present in S/A tenants or co-existent tenants.
- Action: The order actions that have impacted the subscription and taken place in a particular order. If multiple order actions are present in this column, you can click the plus icon (+) in the Version column to display a list of the order actions. At most five order actions can be displayed.
- Details: The detailed change information tagged for each order action in the order.
- Created By
- Created On
- Order Date
- Contract Effective
- Service Activation : This column is present if Zuora is configured to require service activation.
- Customer Acceptance: This column is present if Zuora is configured to require customer acceptance.
Subscribe/Amend Tenants
For a Subscribe/Amend tenant, the Subscription change history table is like below:
It contains the following columns:
- Version: Identifies a certain version of the subscription.
- Amendment Number: Identifies the amendment that contributes to this version of the subscription. This column is present in S/A tenants or co-existent tenants.
- Amendment Type
- Details: The detailed change information tagged for each amendment.
- Created By
- Created On
- Booking Date: The last booking date of the subscription.
- Contract Effective
- Service Activation: This column is present if Zuora is configured to require service activation.
- Customer Acceptance: This column is present if Zuora is configured to require customer acceptance.
View Single Version Subscription Change History
If the Single Version Subscription feature is enabled for your tenant, there is only one version for each subscription. The SubscriptionChangeHistory object provides a clear record of key orders-related changes made to the single version subscription.
You can view the change history of a single version subscription on the subscription detail page.
Alternatively, you can retrieve subscription change history through the Subscription Change History API operations.
To view the change history of a single version subscription in the Zuora UI, perform the following steps:
- Navigate to Customers > Subscriptions in the left-hand navigation section.
- Select the subscription that you want to view the change history. The subscription detail page opens.
- In the Change History section, view the latest changes of the subscription. You can view the changes in the recent orders by clicking More details.
For more information about which order actions are available in the single version subscription UI or API, see Change history.