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 -
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
stop_point:date, which accurately track the duration of the pause period.
- Pause the subscription using the subscription pause schedule API
- Modify the pause interval by utilizing the change subscription pause schedule API
If the pause has already started, only the
stop_point:date can be modified. Otherwise, both the
stop_point:date are available for changes.
Effortlessly receive automatic notifications by subscribing to updates. notifications about status changes are sent with the
Subscription renewals and next charges
- Subscription renewal will not go when it is
- The date of the next charge will be equal to
expired_atfield in subscription status Webhook + days of (
- In case of manually resuming we recalculate next charge date as
expired_atfield in subscription status Webhook + days of (now date -
When a subscription is paused, only the option to
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.
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
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.
- does not exist
- status does not equal
- is planned to:
- from date is greater than the subscription expired at the date
- the schedule does not exist (