Freeze subscription (next generation wizard)

Owned by Karl Lundkvist
Last updated: Apr 23, 2024
3 min read

(TP45972 / 2023.1803)

This wizard, which is available in Beta, can be enabled by BRP staff for specific roles by enabling “Next generation wizard” on a role and adding “Freeze subscription wizard” to the next generation wizard options.

Settings that change the behavior of the wizard

  • minSubscriptionFreezePeriod : If set, will be used to validate against the freeze duration user selects in the wizard. If the chosen subscriptions also have a freeze rule with the minimum duration set, it will override the setting.

  • maxSubscriptionFreezePeriod: If set, will be used to validate against the freeze duration user selects in the wizard. If the chosen subscriptions have a freeze rule with the maximum duration set, it will override the setting.

  • “Subscription - Override subscription freeze rules” lets users enable subscriptions to freeze that were disabled because they violated a property of the freeze rule.

  • “Invoice” - Enable the option “Create invoice” in payment step.

Message templates (used for instructions)

 

Templates can be found in the “Wizards” category in Configuration > Settings > Messages

Only create a custom message template if you wish to override the default template.

Some HTML tags can be used in the message templates

  • <br> for a new line

  • <ul> for an unordered list item (bullet without number)

  • <li> for an ordered list item (bullet with number)

Steps in the Wizard

1 - Select subscriptions

The subscription which launched the wizard will be pre-selected and the users will be able to select other enabled subscriptions that they use or pay for, depending on their freeze condition.

Only subscriptions that have no current or future deviations can be frozen.

 

Freeze conditions for subscriptions can be,

  • Frozen: The subscription has an ongoing deviation of the type “Freeze” and cannot be frozen via the wizard.

  • Planned freezes: The subscription has a future deviation of the type “Freeze” and cannot be frozen via the wizard.

  • Ongoing deviation of other types: The subscription has ongoing deviations of a type other than “Freeze” and can be frozen via the wizard as long as it does not overlap the existing deviation.

  • Planned deviation of other types: The subscription has a planned deviation of a type other than “Freeze” and can be frozen via the wizard as long as it does not overlap the existing deviation.

  • Undebited: The subscription has late payments and cannot be frozen via the wizard.

  • Can not be frozen: The subscription’s freeze rule has the maximum number of freezes per year property set to 0 and therefore this subscription cannot be frozen via the wizard, unless the freeze rule is overridden.

  • Was already frozen “x” times: The subscription was already frozen the number of times allowed by its freeze rule and therefore cannot be frozen via the wizard, unless the freeze rule is overridden.

  • Can be frozen “x”  times (max {number of days or months allowed}) this year: The subscription can be frozen.

  • Can be frozen: The subscription can be frozen.

 

The freeze period: The start and the end date of the freeze. 

Start date: If the subscription’s debited until date is before today, then the start date will be defaulted to today, else it will be the day after the debited until date.

End date: Default end date will be 30 days from the freeze start date.

 

If the user selects subscriptions that do not have the same freeze rule, they will be shown an error message when they attempt to proceed to the next step.

2 - Additional information

Freeze reason: If freeze reasons are configured in the system then the user must select a reason for the freeze in this step. If there is a freeze rule, the choices will be limited to what is configured in the freeze rule.

Comment: An optional field to add comments.

The same freeze reason and comments will be used when creating freezes for all selected subscriptions.

3 - Payment

This step will be enabled only if the user selects a freeze reason which contains a fee. 

The options are,

  • Create invoice

  • Pay in point of sale

  • Open in order panel 

4 - Confirmation

This will summarize the selections of previous steps. The user can go back and change the data if necessary before completing the wizard.