Skip to content

Pause subscription

With the pause function you can temporarily suspend subscriptions or individual subscription components instead of canceling them immediately. Depending on the configuration, tebio can suspend the delivery of goods or access to digital services and make commercial corrections for the period of the break.

Use breaks if the customer is temporarily unable to use a service (for example during vacation trips, company holidays or short-term delivery suspensions).

  • The customer must have an active subscription.
  • Product management must have administratively activated the pause function on the underlying product. Limits are often set here (minimum and maximum break duration as well as maximum number per calendar year).

Depending on the product configuration, you can perform pauses at two levels:

  • At the main product level: If the main product is paused, the entire contract including all additional options attached to it is suspended.
  • At the option level: If only a single option is paused, only that specific performance stops. The main product (and the remaining options) continue to operate as normal.

Start the subscription from the customer view:

  1. Open the customer file. The Subscriptions tab is already open by default.
  2. Click on the desired contract.
  3. Click on the Manage subscription button.

Depending on the desired break level, the entry process differs slightly:

Way A: Pause the entire product (full pause) If product management has allowed pauses at the main product level, you will find a button “Pause subscription” at the top right of the page. Click on it.

Way B: Pause a single option (partial pause) If you only want to suspend a specific additional service, navigate to the corresponding option. Click on the three-dot menu on the right and select the entry “Pause option”.

The pause dialog opens.

  1. Click in the date field to bring up the calendar.
  2. Click the Start Date (first day of the break) and then click the End Date (last day of the break).

Confirm your entry by clicking on Save.

After successful saving, a note with the pause period will be displayed on the corresponding option or on the product.

Depending on the configuration, a pro-rata credit or correction can be generated for the period of the break, which will be taken into account in the next regular invoice.

  • The Pause menu entry is missing: In this case the function is not permitted for this specific product. Check the product configuration or contact product management.
  • Note break limits: Before making your selection, tebio shows which restrictions apply to this break (e.g. “3 - 56 days” in the placeholder text of the date field). The calendar only allows periods that are compatible with these limits.

Breaks can also be submitted and canceled automatically via the REST API. Use the following endpoints for this:

End pointMethodDescriptionOperationId
/v1/subscription/{uuid}/statusPOSTSet subscription status (pause product)setSubscriptionStatus
/v1/subscription/{uuid}/optionsPOSTChange subscription options (pause option)changeSubscriptionOptions
/v1/subscription/{subscriptionUuid}/cancel-pausePOSTCancel planned break for main productcancelScheduledSubscriptionPause
/v1/subscription/{subscriptionUuid}/option-instance/{optionInstanceUuid}/cancel-pausePOSTCancel planned break for optioncancelScheduledSubscriptionOptionPause

Further Subscription API endpoints can be found centrally in the article Edit subscription under “API Notes”.