This page describes how to configue so that members can freeze their subscriptions in the app & web |
Allow freeze of subscription on internet (allowFreezeSubscriptionOnInternet) - This setting should be enabled if freeze should be available without any rules. If all subscription products that should be possible to freeze must have a rule attached to the freeze, the setting should be disabled and only the use of freeze rules should be applied.
Configuration of freeze rules in BRP Configuration is described here.
Note that if freeze rules are defined, these will override the setting ‘Allow freeze of subscription on internet’ for the subscription products which has a rule attached to it. |
‘Instructions before freezing subscriptions’ - This text will be shown in the freeze subscription modal
Members can freeze their subscriptions by going to My Pages > My Subscriptions tab.
By clicking on the menu button (the 3 dots to the right of the subscription) the member will be able to open the actions menu from where they can select to freeze their subscription:
After selecting the freeze option, a modal will be shown to the user similar to the following image:
1 - Freeze instructions
This is the content of the message template “Instructions before freezing subscriptions”, which you can configure through BRP Configuration > Messages in order to provide customized information towards the members.
2 - Information about the subscription that is about to be frozen
3 - Remaining freezes count
If a freeze rule is used for this subscription: according to the definition of the freeze rule, this count will be displayed.
4 - Date range
If the subscription product has a freeze rule, the date range will be validated with the “minimum length of a freeze” and the “maximum length of a freeze” of the freeze rule.
If the subscription product hasn’t a freeze rule, then the end date of the date range will be validated with the `minSubscriptionFreezePeriod` setting and the `maxSubscriptionFreezePeriod` setting
5 - Freeze reasons
Freeze reasons can be configured in BRP Configuration > Subscriptions > Freeze Reasons. A fee can be added for a reason, if the member needs to pay in order to freeze their subscription If the subscription product has a freeze rule, then we show the freeze reasons from the freeze rule. If not: the freeze reasons will only be shown when the “Use freeze reasons” setting is enabled.
6 - Comment
The member can provide a comment along with the freeze reason. This is optional.
When the user clicks the next button, a confirmation modal is displayed:
If there is a freeze rule then its description will show under the freezing rule section. And if the selected reason has a fee then it will show as the freeze fee. If there are additions that will be frozen when freezing this subscription, those will be listed here as well.
After the user clicks the freeze subscription button, if there is a freeze fee to freeze this subscription then the member will be redirected to the payment. After the payment is done and the subscription has been frozen, it will be shown as a “Frozen subscription” on My Pages.
If the freeze start date is not today, it will show as an Active Subscription with information about the future freeze:
