View event history
The tebio Business Portal logs important events in the life cycle of a subscription. In the event history you will find detailed overviews of past and planned status changes, pauses, and system and user actions.
When do I need this function?
Section titled “When do I need this function?”Use event history if you want to track changes or processes to a subscription. Typical questions are:
- When was the subscription paused by the customer?
- Who recorded the termination in the system?
- Was the last automatic renewal successful?
Requirements
Section titled “Requirements”- You need access to the detailed view of an active, paused or canceled subscription.
Step-by-step instructions
Section titled “Step-by-step instructions”1. Open the event view
Section titled “1. Open the event view”You can access the detailed view of the contract in two different ways:
Way 1: Via the customer view
- Open the relevant user’s customer view.
- Select the contract you want from the dropdown.
- Click on “Show details” to switch to the detailed view of the subscription.
Way 2: Via Global Search
- Use the direct search in the top menu under “Subscriptions”.
- Search for the specific contract number and click on the result.
Once you are in the subscription detail view, the first tab “Events” is already open by default.
2. Understand the history
Section titled “2. Understand the history”The view is divided into three different tables to present information in context:
1. Status changes All basic status changes of the main product and the booked options are listed here (e.g. change from active to paused or deactivated). You can see at a glance the date, the affected product, as well as the old and new status.
2. Breaks In this table, all past, active and future planned breaks are clearly logged with their start (“break from”) and end date (“break to”).
3. Events This is the subscription’s event log. Here, every system action (e.g. “subscription extension was successful”) and every user action is logged chronologically. The “User Account” column tells you which system, module or user carried out the action (the system module or a specific employee or customer).
Result
Section titled “Result”You can understand the history of the subscription and answer customer inquiries about the past contract based on data.
Notes and typical errors
Section titled “Notes and typical errors”- Adjust columns: If you are missing important information in the tables or would like to slim down the view, click on the Edit Columns button at the top right of the respective table.
- Note pagination: The detailed event history can be very long for long-lived contracts. Use the pagination at the bottom right of the table to access older entries or set the “positions per page” higher.
API Notes
Section titled “API Notes”The tebio API provides its own endpoints for the programmatic evaluation of the history:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/subscription/event-history | GET | Search and filter subscription event history | searchSubscriptionEventHistory |
/v1/subscription/event-history/{uuid} | GET | Retrieve event history for a specific subscription | getSubscriptionEventHistory |
In addition, the structured arrays for historical and planned breaks can also be read out using the generic retrieval of the subscription (GET /v1/subscription/{uuid}).