Edit subscription
Changes may become necessary during the term of a subscription: For example, customers want to pause, add options, receive discounts or cancel the subscription. The tebio business portal offers you the functions you need to map these processes and control them in a comprehensible manner.
When do I need this function?
Section titled “When do I need this function?”Once a subscription exists for a customer, you can make adjustments. The portal differentiates between two main actions:
- Show details: Use this area for administrative and informational tasks. Here you can check the history, assign properties and resources (such as license keys), upload documents or adjust the general subscription status (e.g. a lock).
- Manage subscription: This is your tool for commercial and tariff interventions. Here you can change plans or products, book options, set up breaks, grant discounts or cancel the subscription.
Requirements
Section titled “Requirements”- You need access to the tebio Business portal with the corresponding contract management rights.
- The subscription to be processed must already exist in the system.
Step-by-step instructions
Section titled “Step-by-step instructions”Open subscription for editing
Section titled “Open subscription for editing”Although there is also the option of direct subscription search, a frequently used way is via the customer view:
- Navigate to Customers and open the desired customer view.
- The Subscriptions tab is open by default.
- Find the subscription you want in the list and click on the corresponding entry.
- Now, depending on your plans, select either Show details or Manage subscription.
Area 1: Show details (management and history)
Section titled “Area 1: Show details (management and history)”In this view you have an overview of technical and commercial information about the subscription.
The following essential functions are available to you here:
Add properties
Section titled “Add properties”You can use the Properties dialog to assign specific metadata to the subscription (based on the preconfigured properties, see article Configure properties). This is useful for evaluations or internal controls (e.g. storing a reason for termination).
Change status
Section titled “Change status”You can change the status of a subscription:
- Status Blocked: Invoicing and calculations continue as normal. However, depending on the system configuration, the customer’s physical or digital access to the service will be interrupted.
- Status Disabled: This ends the subscription. The contractual relationship is finally terminated (either immediately or on a specific date).
Documents and resources
Section titled “Documents and resources”In the corresponding tabs, you can assign resources to the contract (such as hardware serial numbers or license keys) or upload contract-relevant documents (terms of use, contracts).
Area 2: Manage Subscription (Commercial Changes)
Section titled “Area 2: Manage Subscription (Commercial Changes)”This area is for commercial changes during the term.
Here you can see the main product as well as the booked and available options. You can also use “Show details” to reveal the contractual conditions (e.g. postpaid, monthly).
Pause options
Section titled “Pause options”If you want to temporarily suspend a service, you can temporarily pause not only the main product, but also specific individual options (e.g. delivery of a newspaper) using the 3-point menu.
Change tariff/options
Section titled “Change tariff/options”For example, if the customer wants to switch from one option to another option, open the switch dialog. Here you can see the new costs and determine whether the change should take place immediately or scheduled (e.g. at the turn of the month).
Cancel subscription
Section titled “Cancel subscription”At the bottom left of the “Manage subscription” screen you will find the Cancel subscription button. (Alternatively, a subscription can also be deactivated via the status change in the detailed view, as described above). In the cancellation dialog you select the end date and optionally enter the reason for cancellation.
Result
Section titled “Result”Every change made to the subscription is logged by the system. In the Events tab (under “Show details”) it is fully documented which specific user (employee, customer, system) made a change, pause or status adjustment and when. Scheduled operations (such as a later option change) are placed in the queue and executed automatically on the deadline.
Notes and typical errors
Section titled “Notes and typical errors”[!CAUTION] Cancellation during breaks You cannot cancel the subscription during an ongoing or planned break. The reason lies in the commercial calculation: breaks change the remaining term. They have a direct influence on the calculation of the minimum term and postpone the next possible termination date into the future. Canceling during a break may result in incorrect term or billing calculations. Solution: End or cancel the break first before recording the cancellation.
- Blocked vs. Disabled: Carefully differentiate status options. “Blocked” is a measure for e.g. B. Late payment – invoicing continues. Only “Disabled” (or regular cancellation) stops the billing cycle permanently.
API Notes
Section titled “API Notes”You can also control these processes from external systems (e.g. app or ERP system) using the REST API:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/subscription | GET | Search subscriptions | searchSubscription |
/v1/subscription | POST | Create subscription | createSubscription |
/v1/subscription/{uuid}/deactivate | POST | Deactivate (cancel) subscription | deactivateSubscription |
/v1/subscription/{subscriptionUuid}/rescind-scheduled-option-change | POST | Revoke planned option change | rescindScheduledOptionChange |
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}/deactivate | POST | Deactivate subscription via external reference | deactivateSubscriptionByExtSubscriptionRef |
/v1/subscription/{uuid}/status | POST | Set subscription status (e.g. block) | setSubscriptionStatus |
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}/status | POST | Set subscription status via external reference | setSubscriptionStatusByExtSubscriptionRef |
/v1/subscription/{uuid} | GET | Get subscription | getSubscription |
/v1/subscription/{uuid} | PATCH | Update subscription metadata | updateSubscription |
/v1/subscription/extSubscriptionRef/{extSubscriptionRef} | GET | Retrieve subscription via external reference | getSubscriptionByExtSubscriptionRef |
/v1/subscription/extSubscriptionRef/{extSubscriptionRef} | PATCH | Update subscription via external reference | updateSubscriptionByExtSubscriptionRef |
/v1/subscription/{uuid}/options | POST | Change/book subscription options | changeSubscriptionOptions |
/v1/subscription/{uuid}/product-change | POST | Carry out product changes | subscriptionProductChange |
/v1/subscription/{sourceSubscriptionUuid}/cancel-productchange | POST | Cancel planned product change | cancelSubscriptionProductChange |
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}/options | POST | Switch options via external reference | changeSubscriptionOptionsByExtSubscriptionRef |
/v1/subscription/{subscriptionUuid}/cancel-deactivation | POST | Cancel planned deactivation | cancelScheduledSubscriptionDeactivation |
/v1/subscription/{subscriptionUuid}/cancel-pause | POST | Cancel planned break for main product | cancelScheduledSubscriptionPause |
/v1/subscription/{subscriptionUuid}/option-instance/{optionInstanceUuid}/cancel-pause | POST | Cancel planned break for option | cancelScheduledSubscriptionOptionPause |
/v1/subscription/extstatus | POST | Set external status | setSubscriptionExtStatus |
/v1/subscription/event-history/{uuid} | GET | Get subscription event history | getSubscriptionEventHistory |
/v1/subscription/event-history | GET | Search event history | searchSubscriptionEventHistory |
/v1/subscription/resource | GET | Find subscription resources | searchSubscriptionResource |
/v1/subscription/resource | POST | Add resources to the subscription | createSubscriptionResource |
/v1/subscription/resource | DELETE | Delete subscription resources | deleteSubscriptionResource |
/v1/subscription/resource | PATCH | Update subscription resources | updateSubscriptionResource |
/v1/subscription/resource/{uuid} | GET | Get specific resource | getSubscriptionResource |