Difference between revisions of "M4 Charge Plans"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''FUNCTIONALITY IS IN THE DEVELOPMENT STAGE'''
<br><br><br>
<html>
<div align="center">
<iframe width="640" height="360" src="https://www.youtube.com/embed/R5LmO-tD1jg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
</html>
<br><br>
 
= Description =  
= Description =  
M4 Charge Plan is a plan which allows charging '''One-Time''' or '''Periodic''' fees. Charge Plan is used in [[M4 Services|Services]], [[M4 DID Management|DIDs]] and Subsciptions.
Charge Plan is a set of options that determines HOW MUCH and HOW we will charge for some service. Charge Plan is a template for Subscriptions.
<br><br>
<br><br>
= Usage =
= Usage =
Line 12: Line 19:
[[File:Charge plans list.png]]
[[File:Charge plans list.png]]
<br><br>
<br><br>
== Charge Plan Settings ==  
= Charge Plan Settings =
Charge plan can be a '''Periodic Charge''' or '''One-Time Charge'''.
The Charge Plan can be a '''Periodic Charge''' or '''One-Time Charge'''.
=== Charge Plan Settings for Periodic Charge ===
== Charge Plan Settings for Periodic Charge ==
<br>
<br>
[[File:Charge plan periodic new.png]]
[[File:Charge_plans_m4_new.png]]
<br><br>
<br><br>
'''General Settings''':
===General Settings ===
* '''Charge Plan Name''' - name of the Charge Plan.
* '''Name''' - name of the Charge Plan.
* '''Charge Plan Name visible to end User''' - name of Charge Plan that will be visible to end User.
* '''Name visible to end User''' - the name of the Subscription that will be visible to the end User. This name will be included in Invoices.
* '''Status''' - status of created Charge Plan. Available options: '''Active''', '''Disabled'''.
* '''Status''' - status of the Charge Plan.
* '''Can be applied more than once''' - if set, Charge Plan can be applied more than once. Default: '''No'''.
* '''Can be applied more than once''' - if set, Charge Plan can be applied more than once to the same User.
* '''Description''' - description of the Charge Plan.
* '''Description''' - description of the Subscription.
<br>
<br>
'''Period Settings''':
 
* '''Period''' - the period can be in  day(s), week(s), month(s) or year(s).
===Period Settings===
* '''Align to Customer Billing Period''' - Align Period.
* '''Period''' - subscription period (day(s), week(s), month(s), or year(s)). The number defines how long is the period. For example, if the period is set to a month and the number is set to 1, then a common monthly period will be used as the subscription period. The user will be charged for a single month and the charging repeats every month until the subscription is canceled. If the period is set to a month and the number is set to 6, then the user will be charged one time every 6 months (for example, if the subscription price is 10 EUR, then the subscription will be charged 10 EUR for those 6 months).
** '''Full charge First Period (do not prorate)''' - charge the full amount on the first period. For example, if the Charge Plan price is 10 EUR, the period is monthly, and it has been applied on the 27th of May, with this option enabled, May will be charged for the full 10 EUR. With option disabled May month will be charged for (31-27)/31 * 10 = 1.29 EUR.
* '''Align Period''' - if set, then the first and the last subscription periods will be aligned. This option is only relevant when a subscription starts in the middle of the period.
** '''Full charge Last Period (do not prorate)''' - same logic as above, but for Last Period.
 
Examples of aligned and non-aligned periods:
 
If a '''monthly''' subscription starts on 2023-01-01 00:00:00, then there is no need to enable '''Align Period''' option since the subscription starts on the first day of the month (it is already aligned).
<br/><br/>
If a '''monthly''' subscription starts on 2023-01-10 00:00:00 and '''Align Period''' is '''not enabled''', then subscription periods will always start on the 10th day of the month (the period is not aligned to the actual month):
<br/><br/>
2023-01-10 00:00:00 - 2023-02-09 23:59:59 (first period)<br/>
2023-02-10 00:00:00 - 2023-03-09 23:59:59 (second period)<br/>
2023-03-10 00:00:00 - 2023-04-09 23:59:59 (third period)<br/>
 
If a '''monthly''' subscription starts on 2023-01-10 00:00:00 and '''Align Period''' is '''enabled''', then the first subscription period will be adjusted (aligned) to end on the last day of the month so that the other periods will start on the first day of the month:
<br/><br/>
2023-01-10 00:00:00 - 2023-01-31 23:59:59 (first period)<br/>
2023-02-01 00:00:00 - 2023-02-28 23:59:59 (second period)<br/>
2023-03-01 00:00:00 - 2023-03-31 23:59:59 (third period)<br/>
 
Note that after Period adjustment, the first period is shorter (only 22 active days). In this case, additional options allow you to either charge the full price (for a whole month) or charge for active days only.
 
* '''Full charge First Period (do not prorate)''' - charge the full amount on the first period. For example, if the Charge Plan price is 10 EUR, the period is monthly, and the subscription starts on the 10th of January, with this option enabled, January will be charged for the full 10 EUR. With the option disabled, January month will be charged for 22 active days: (10/30) * 22 = 7.33 EUR (here 10/30 is the price for a single day, 22 is active days).
* '''Full charge Last Period (do not prorate)''' - same logic as above, but for Last Period.
<br>
<br>
'''Periodic Charge Settings:'''
 
* '''Try to renew in advance''' - hour(s) or days(s) in advance to try renewing Charge Plan for a User.
===Periodic Charge Settings===
* '''Try to renew for''' - hours(s) or days(s) which we will try to renew Charge Plan.
* '''Try to renew in advance''' - hour(s) or days(s) in advance to try renewing (charging) subscription. For example, if this option is set to 1 hour, then the subscription will be charged 1 hour before the actual subscription period starts.
* '''Try to renew for''' - hours(s) or days(s) for how long we will try to renew (charge) subscription.
* '''Apply subscription Charges:''' - how to apply subscription Charges. Available Options:
* '''Apply subscription Charges:''' - how to apply subscription Charges. Available Options:
** '''At the end of the Period'''.
** '''At the end of the Period''' - subscription will be charged at the end of the period.
** '''In advance'''.
** '''In advance''' - subscription will be charged at the beginning of the period.
*** '''Periods in advance''' - how many periods charge in advance. Default: '''1'''.
*** '''Periods in advance''' - how many periods charge in advance. Default: '''1'''.
** '''Progressively (every day)'''.
** '''Progressively (every day)''' - subscription will be charged daily for a fraction of the full period price.
* '''Charge Suspended Customers''' - at the time of apply subscription Charges, should we charge a Suspended Customer (User). Default: '''No'''.
* '''Charge Suspended Customers''' - at the time of applying subscription Charges, should we charge a Suspended Customer (User)? Default: '''No'''.
* '''If balance insufficient:'''
** '''Block User''' - yes or no.
** '''Suspend Service''' - yes or no.
** '''Charge Subscription''' - yes or no.
'''Note:''' Profit loss is possible if all three options are unchecked.
** '''Send Email Notification to:''' - send email notification when the balance is insufficient to charge a subscription.
***'''Admin''' - send to Admin by selected template.
***'''User''' - send to User by selected template.
<br>
<br>
'''Activation Settings:'''
 
===Activation Settings===
* '''Subscription is Activated''' - either on '''At the given start date''' or '''Upon the first usage'''.
* '''Subscription is Activated''' - either on '''At the given start date''' or '''Upon the first usage'''.
* '''If balance insufficient''' - either '''Allow activation''' or '''Deny activation'''.
* '''If balance insufficient''' - either '''Allow activation''' or '''Deny activation'''.
* '''Charge for Past''' – charge subscription for past dates. Example:
* '''Charge for Past''' – charge subscription for past dates. Example: subscription start period is set to 2022-01-01, but added on 2022-02-01 with the selected option, 2022-01-01 will also be charged<br>
Periodic Charge: Subscription Activation Start Period 2022.01.01, but added on 25.01.2022. With the selected option subscription should be charged for the past.
<br>
<br>
'''Cancellation Settings:'''
 
* '''Minimum Subscription Period''' - period in '''months''' for which Customer will be charged if subscription is canceled earlier.
===Cancellation Settings===
* '''Minimum Subscription Period''' - a period in '''months''' for which Customer will be charged if the subscription is canceled earlier.
** '''Early Cancellation Penalty''' - either '''Fixed''' (enter manual value) or '''Remaining Subscription charges'''.
** '''Early Cancellation Penalty''' - either '''Fixed''' (enter manual value) or '''Remaining Subscription charges'''.
<br>
<br>
'''Credits:'''
===Credits===
* '''Issue credits for the days when:''' - select any combination (one, few, all, none) of the bellow:
* '''Issue credits for the days when:''' - issue money refund for days when the User was not able to use the subscription due to being blocked, suspended, or both.
** '''The customer was blocked'''.
** '''The customer was blocked'''.
*** '''Invoice Line Name''' - name in Invoice for blocked days refund.
** '''The service was suspended'''.
** '''The service was suspended'''.
** '''No funds were available'''.
*** '''Invoice Line Name''' - name in Invoice for suspended service refund.


* ''' Skip credits, charge in full:''' - select any combination (one, few, all, none) of the bellow:
* ''' Skip credits, charge in full:''' - skip money refund for specific periods.
** '''For the first billing period'''.
** '''For the first billing period'''.
** '''For the regular billing periods'''.
** '''For the regular billing periods'''.
** ''' For the last billing period'''.
** ''' For the last billing period'''.
<br>
<br>
'''Billing Settings:'''
 
===Billing Settings===
 
* '''Currency''' - one of the active currencies in the system.
* '''Currency''' - one of the active currencies in the system.
* '''Activation Fee''' - fee for a Charge Plan activation.
* '''Activation Fee''' - fee for a Charge Plan activation.
Line 70: Line 110:
* '''Rounding Precision''' - rounding precision in decimals.
* '''Rounding Precision''' - rounding precision in decimals.
* '''Rounding method''' - available options:
* '''Rounding method''' - available options:
** '''Up'''-  round to higher value. If precision is 2 decimals 5.377xxxxxx will be rounded to 5.38.
** '''Up''' -  round to higher value. If the precision is 2 decimals 5.377xxxxxx will be rounded to 5.38.
** '''Down''' - round to lover value. If precision is 2 decimals 5.377xxxxxx will be rounded to 5.37.
** '''Down''' - round to lover value. If precision is 2 decimals 5.377xxxxxx will be rounded to 5.37.
** '''Round''' - round to nearest value using simple rounding logic. If precision is 2 decimals 5.355 will rounded to 5.36, and 5.354 will be rounded to 5.35).
** '''Round''' - round to nearest value using simple rounding logic. If precision is 2 decimals 5.355 will be rounded to 5.36, and 5.354 will be rounded to 5.35).
<br>
<br>


=== Charge Plan Settings for One-Time Charge ===
== Charge Plan Settings for One-Time Charge ==
<br><br>
<br><br>
[[File:Charge plan one time new.png]]
[[File:Charge plan one time new.png]]
<br><br>
<br><br>
'''General Settings:'''
===General Settings===


Same settings as in General Settings for [[M4_Charge_Plans#Charge_Plan_Settings|Periodic Charge]].  
Same settings as in General Settings for [[M4_Charge_Plans#Charge_Plan_Settings|Periodic Charge]].  
<br><br>
<br><br>
'''Activation Settings:'''
===Activation Settings===
* '''If balance insufficient''' - either '''Allow activation''' or '''Deny activation'''.
* '''If balance insufficient''' - either '''Allow activation''' or '''Deny activation'''.
<br>
<br>
'''Billing Settings:'''
===Billing Settings===


The same as Billing Settings for Periodic Charge, only '''Periodic Fee''' option is not available.
The same as Billing Settings for Periodic Charge, only '''Periodic Fee''' option is not available.

Latest revision as of 13:31, 22 February 2024






Description

Charge Plan is a set of options that determines HOW MUCH and HOW we will charge for some service. Charge Plan is a template for Subscriptions.

Usage

Go to ACCOUNTING –> Subscriptions –> Charge Plans:

Charge plans menu.png

Here you can see the list of Charge Plans and create a new Charge Plan.

Charge plans list.png

Charge Plan Settings

The Charge Plan can be a Periodic Charge or One-Time Charge.

Charge Plan Settings for Periodic Charge


Charge plans m4 new.png

General Settings

  • Name - name of the Charge Plan.
  • Name visible to end User - the name of the Subscription that will be visible to the end User. This name will be included in Invoices.
  • Status - status of the Charge Plan.
  • Can be applied more than once - if set, Charge Plan can be applied more than once to the same User.
  • Description - description of the Subscription.


Period Settings

  • Period - subscription period (day(s), week(s), month(s), or year(s)). The number defines how long is the period. For example, if the period is set to a month and the number is set to 1, then a common monthly period will be used as the subscription period. The user will be charged for a single month and the charging repeats every month until the subscription is canceled. If the period is set to a month and the number is set to 6, then the user will be charged one time every 6 months (for example, if the subscription price is 10 EUR, then the subscription will be charged 10 EUR for those 6 months).
  • Align Period - if set, then the first and the last subscription periods will be aligned. This option is only relevant when a subscription starts in the middle of the period.

Examples of aligned and non-aligned periods:

If a monthly subscription starts on 2023-01-01 00:00:00, then there is no need to enable Align Period option since the subscription starts on the first day of the month (it is already aligned).

If a monthly subscription starts on 2023-01-10 00:00:00 and Align Period is not enabled, then subscription periods will always start on the 10th day of the month (the period is not aligned to the actual month):

2023-01-10 00:00:00 - 2023-02-09 23:59:59 (first period)
2023-02-10 00:00:00 - 2023-03-09 23:59:59 (second period)
2023-03-10 00:00:00 - 2023-04-09 23:59:59 (third period)

If a monthly subscription starts on 2023-01-10 00:00:00 and Align Period is enabled, then the first subscription period will be adjusted (aligned) to end on the last day of the month so that the other periods will start on the first day of the month:

2023-01-10 00:00:00 - 2023-01-31 23:59:59 (first period)
2023-02-01 00:00:00 - 2023-02-28 23:59:59 (second period)
2023-03-01 00:00:00 - 2023-03-31 23:59:59 (third period)

Note that after Period adjustment, the first period is shorter (only 22 active days). In this case, additional options allow you to either charge the full price (for a whole month) or charge for active days only.

  • Full charge First Period (do not prorate) - charge the full amount on the first period. For example, if the Charge Plan price is 10 EUR, the period is monthly, and the subscription starts on the 10th of January, with this option enabled, January will be charged for the full 10 EUR. With the option disabled, January month will be charged for 22 active days: (10/30) * 22 = 7.33 EUR (here 10/30 is the price for a single day, 22 is active days).
  • Full charge Last Period (do not prorate) - same logic as above, but for Last Period.


Periodic Charge Settings

  • Try to renew in advance - hour(s) or days(s) in advance to try renewing (charging) subscription. For example, if this option is set to 1 hour, then the subscription will be charged 1 hour before the actual subscription period starts.
  • Try to renew for - hours(s) or days(s) for how long we will try to renew (charge) subscription.
  • Apply subscription Charges: - how to apply subscription Charges. Available Options:
    • At the end of the Period - subscription will be charged at the end of the period.
    • In advance - subscription will be charged at the beginning of the period.
      • Periods in advance - how many periods charge in advance. Default: 1.
    • Progressively (every day) - subscription will be charged daily for a fraction of the full period price.
  • Charge Suspended Customers - at the time of applying subscription Charges, should we charge a Suspended Customer (User)? Default: No.
  • If balance insufficient:
    • Block User - yes or no.
    • Suspend Service - yes or no.
    • Charge Subscription - yes or no.

Note: Profit loss is possible if all three options are unchecked.

    • Send Email Notification to: - send email notification when the balance is insufficient to charge a subscription.
      • Admin - send to Admin by selected template.
      • User - send to User by selected template.


Activation Settings

  • Subscription is Activated - either on At the given start date or Upon the first usage.
  • If balance insufficient - either Allow activation or Deny activation.
  • Charge for Past – charge subscription for past dates. Example: subscription start period is set to 2022-01-01, but added on 2022-02-01 with the selected option, 2022-01-01 will also be charged


Cancellation Settings

  • Minimum Subscription Period - a period in months for which Customer will be charged if the subscription is canceled earlier.
    • Early Cancellation Penalty - either Fixed (enter manual value) or Remaining Subscription charges.


Credits

  • Issue credits for the days when: - issue money refund for days when the User was not able to use the subscription due to being blocked, suspended, or both.
    • The customer was blocked.
      • Invoice Line Name - name in Invoice for blocked days refund.
    • The service was suspended.
      • Invoice Line Name - name in Invoice for suspended service refund.
  • Skip credits, charge in full: - skip money refund for specific periods.
    • For the first billing period.
    • For the regular billing periods.
    • For the last billing period.


Billing Settings

  • Currency - one of the active currencies in the system.
  • Activation Fee - fee for a Charge Plan activation.
    • Invoice Line Name - name in Invoice for a Activation Fee.
  • Periodic Fee - Periodic Charge Plan Fee.
    • Invoice Line Name - name in Invoice for a Periodic Fee.
  • Rounding Precision - rounding precision in decimals.
  • Rounding method - available options:
    • Up - round to higher value. If the precision is 2 decimals 5.377xxxxxx will be rounded to 5.38.
    • Down - round to lover value. If precision is 2 decimals 5.377xxxxxx will be rounded to 5.37.
    • Round - round to nearest value using simple rounding logic. If precision is 2 decimals 5.355 will be rounded to 5.36, and 5.354 will be rounded to 5.35).


Charge Plan Settings for One-Time Charge



Charge plan one time new.png

General Settings

Same settings as in General Settings for Periodic Charge.

Activation Settings

  • If balance insufficient - either Allow activation or Deny activation.


Billing Settings

The same as Billing Settings for Periodic Charge, only Periodic Fee option is not available.



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=M4_Charge_Plans&oldid=29433"