Skip to content

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.

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

Although there is also the option of direct subscription search, a frequently used way is via the customer view:

  1. Navigate to Customers and open the desired customer view.
  2. The Subscriptions tab is open by default.
  3. Find the subscription you want in the list and click on the corresponding entry.
  4. 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:

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

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

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

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.

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

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.

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.

[!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.

You can also control these processes from external systems (e.g. app or ERP system) using the REST API:

End pointMethodDescriptionOperationId
/v1/subscriptionGETSearch subscriptionssearchSubscription
/v1/subscriptionPOSTCreate subscriptioncreateSubscription
/v1/subscription/{uuid}/deactivatePOSTDeactivate (cancel) subscriptiondeactivateSubscription
/v1/subscription/{subscriptionUuid}/rescind-scheduled-option-changePOSTRevoke planned option changerescindScheduledOptionChange
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}/deactivatePOSTDeactivate subscription via external referencedeactivateSubscriptionByExtSubscriptionRef
/v1/subscription/{uuid}/statusPOSTSet subscription status (e.g. block)setSubscriptionStatus
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}/statusPOSTSet subscription status via external referencesetSubscriptionStatusByExtSubscriptionRef
/v1/subscription/{uuid}GETGet subscriptiongetSubscription
/v1/subscription/{uuid}PATCHUpdate subscription metadataupdateSubscription
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}GETRetrieve subscription via external referencegetSubscriptionByExtSubscriptionRef
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}PATCHUpdate subscription via external referenceupdateSubscriptionByExtSubscriptionRef
/v1/subscription/{uuid}/optionsPOSTChange/book subscription optionschangeSubscriptionOptions
/v1/subscription/{uuid}/product-changePOSTCarry out product changessubscriptionProductChange
/v1/subscription/{sourceSubscriptionUuid}/cancel-productchangePOSTCancel planned product changecancelSubscriptionProductChange
/v1/subscription/extSubscriptionRef/{extSubscriptionRef}/optionsPOSTSwitch options via external referencechangeSubscriptionOptionsByExtSubscriptionRef
/v1/subscription/{subscriptionUuid}/cancel-deactivationPOSTCancel planned deactivationcancelScheduledSubscriptionDeactivation
/v1/subscription/{subscriptionUuid}/cancel-pausePOSTCancel planned break for main productcancelScheduledSubscriptionPause
/v1/subscription/{subscriptionUuid}/option-instance/{optionInstanceUuid}/cancel-pausePOSTCancel planned break for optioncancelScheduledSubscriptionOptionPause
/v1/subscription/extstatusPOSTSet external statussetSubscriptionExtStatus
/v1/subscription/event-history/{uuid}GETGet subscription event historygetSubscriptionEventHistory
/v1/subscription/event-historyGETSearch event historysearchSubscriptionEventHistory
/v1/subscription/resourceGETFind subscription resourcessearchSubscriptionResource
/v1/subscription/resourcePOSTAdd resources to the subscriptioncreateSubscriptionResource
/v1/subscription/resourceDELETEDelete subscription resourcesdeleteSubscriptionResource
/v1/subscription/resourcePATCHUpdate subscription resourcesupdateSubscriptionResource
/v1/subscription/resource/{uuid}GETGet specific resourcegetSubscriptionResource