Pause subscription
Pause subscription
Discover how to pause, resume, and manage subscriptions, including handling renewals

In some cases, your customers may want to temporarily pause their subscription for the following reasons:

  • They may be unable to use your product for a certain period of time.
  • They may be temporarily absent from their location.

You have the option to pause the subscription via the API, and such paused subscriptions will be identified by a distinct status - paused.

Subscriptions can be put on hold for a defined period, but it is important to note that a resume date and time must be specified. It is not possible to pause the subscription indefinitely.

The API provides functionalities to create, update, delete, and manage the paused status for user subscriptions. This allows you to set a pause period from a specific point to a designated date, as well as make changes or cancel the pause if needed.

Managing subscription pause

The pause subscription feature provides businesses with the ability to temporarily halt an active subscription, enabling customers to suspend their subscription for a defined period. This functionality allows for seamless transition between the active status and pause status, giving customers the option to reactivate their subscription or proceed with a permanent cancellation. The subscription details include essential fields such as start_point:date and stop_point:date, which accurately track the duration of the pause period.

If the pause has already started, only the stop_point:date can be modified. Otherwise, both the start_point:date and stop_point:date are available for changes.

During the subscription pause, no renewals or charges will occur, and Guide
Effortlessly receive automatic notifications by subscribing to updates.
notifications
about status changes are sent with the pause type.

Subscription renewals and next charges

  • Subscription renewal will not go when it is paused.
  • The date of the next charge will be equal to expired_at field in subscription status Webhook + days of (pause:from_date - pause:to_date)
  • In case of manually resuming we recalculate next charge date as expired_at field in subscription status Webhook + days of (now date - pause:from_date)

Subscription cancellation

When a subscription is paused, only the option to Guide
This cancellation type allows the subscriber to continue using the services until the end of the paid period while maintaining the subscription in an active status.
hard cancel
is available. The option for a Guide
This cancellation type involves an immediate change of the subscription status to cancel.
soft cancel
is not applicable.

The functionality to pause a subscription will not be accessible if the subscription is in a "soft cancel" status.

Resume a subscription

Only subscriptions in the paused status can be resumed.

Use the remove subscription pause schedule API functionality to delete a scheduled pause and revert the subscription to its previous active state.

Constraints and limitations

Respond with error code Guide
Understand why the payment is declined and how you can resolve it.
2.01
.

Pause from/to date:

  • doesn’t exist in the request
  • is lower than now date

Pause period is lower than 1 day.

Subscription:

  • does not exist
  • status does not equal active
  • is planned to:
    • cancelled
    • paused
  • pause:
    • from date is greater than the subscription expired at the date
    • the schedule does not exist (start_point:date is null)