Difference between revisions of "M4 Subscriptions"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<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>
Subscription describes HOW MUCH, HOW (in what terms), for WHAT Service we will charge? And WHO will pay?
= Usage =
= Usage =
Go to '''ACCOUNTING –> Subscriptions''':
Go to '''ACCOUNTING –> Subscriptions''':
Line 4: Line 14:
[[File:M4_subscriptions.png]]
[[File:M4_subscriptions.png]]
<br><br>
<br><br>
Here you can see the list of Subscriptions and create a new Subscriptions.<br><br>
Here you can see the list of Subscriptions and create new Subscriptions.<br><br>


[[File:M4_subscriptions_list.png]]
[[File:M4_subscriptions_list.png]]
Line 19: Line 29:
=== New Subscription ===
=== New Subscription ===


* '''User''' - select a User.
* '''User''' - choose a User for the Subscription.
* '''Type''' - Subscription type.
* '''Type''' - select the type of Subscription.
** '''DID''' - if a Subscription type is '''DID''', then search DID to subscribe by Tags, DID number, or Destination.
** '''DID''' - if the Subscription Type is "DID," search for and subscribe using Tags, DID number, or Destination.
** '''Flat-Rate''' - if a Subscription type is '''Flat-Rate''', then select Flat-Rate Plan from drop-down.
** '''Flat-Rate''' - if the Subscription Type is "Flat-Rate," select a plan from the drop-down menu.
* '''Discount''' - Subscription Discount. It will affect the Subscription price for the User.
** '''Custom Service''' - if the Subscription Type is "Custom Service," select a service from the drop-down menu.
* '''Activation''' date - Subscription Activation date. Billing starts from this date.
* '''Discount''' - apply a discount to affect Activation and Periodic Fees.
* '''Start Date''' - date from when Subscription starts.
** '''Activation Fee''' - discount for Activation Fee.
* '''Finish Date''' - date when Subscription finishes.
** '''Periodic Fee''' - discount for Periodic Fee.
* '''Until canceled?''' - it is also possible to set the Finish Date to Until canceled option. In this case, the Subscription will only end, when it is removed or the Finish Date option is changed to a specific date (except Until canceled).
* '''Start Date''' - the date when the Subscription becomes active.
* '''Charge Plan''' - select Charge Plan. More information can be found [[M4 Charge Plans|here]].<br><br>
* '''Finish Date''' - the date when the Subscription ends.
* '''DID Status on Finish Date''' - '''Available for DID Subscriptions'''. Sets DID status when Subscription is finished. Possible values are: Free, Blocked, Reserved, and Archived.
* '''Until canceled?''' - If checked, the Subscription remains active until manually closed.
* '''Charge Plan''' - select the Charge Plan. More information can be found [[M4 Charge Plans|here]].<br><br>


=== General Settings ===
=== General Settings ===


* '''Periodic Charge''' - user is charged periodically.
* '''Periodic Charge''' - the Susbcription will be charged periodically.
* '''One-Time Charge''' - user is charged only once.
* '''One-Time Charge''' - the Subscription will be charged only once.
* '''Charge Plan Name''' - Charge Plan Name.
* '''Charge Plan Name''' - Charge Plan Name.
* '''Charge Plan Name visible to end user''' - Charge Plan Name visible to end user.
* '''Charge Plan Name visible to end user''' - Charge Plan Name visible to User. This name will be included in Invoices.
* '''Status''' - Active or Disabled.
* '''Can be applied more than once''' - if set, Charge Plan can be applied more than once. Default: '''No'''.
* '''Description''' - Subscription description.<br><br>
* '''Description''' - Subscription description.<br><br>


=== Period Settings ===
=== Period Settings ===


* '''Period''' - the period can be in hours(s), day(s), month(s) or year(s).
* '''Period''' - the period can be in hours, days, months or years.
* '''Align to Customer Billing Period''' - set the period to the one that is set in [[M2_Users#Static_Invoice_Billing_Period_time| User's Invoice Billing Period]].
* '''Align Period''' - More information can be found [[M4 Charge Plans|here]].
** '''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.
** '''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 the option disabled May month will be charged for (31-27)/31 * 10 = 1.29 EUR.
** '''Full charge Last Period (do not prorate)''' - same logic as above, but for Last Period. <br><br>
** '''Full charge Last Period (do not prorate)''' - same logic as above, but for Last Period. <br><br>


Line 56: Line 67:
*** '''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)'''.
* '''Charge Suspended Customers''' - at the time of apply subscription Charges, should we charge a Suspended Customer (User). Default: '''No'''. <br><br>
* '''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:'''
***'''Admin'''
***'''User'''<br><br>


=== Activation Settings ===
=== Activation Settings ===
Line 65: Line 84:
=== Cancellation Settings ===
=== Cancellation Settings ===


* '''Minimum Subscription Period''' - period in '''months''' for which Customer will be charged if subscription is canceled earlier.
* '''Minimum Subscription Period''' - a period in '''days/weeks/months/years''' for which Customer will be charged if a subscription is canceled earlier. Depends on the Period Settings.
* '''Early Cancellation Penalty''' - Fixed or Remaining Subscription charges. Set the amount if fixed is selected.
* ''' Invoice Line Name''' - name in Invoice for a subscription cancelation.<br><br>
 
=== Credits ===
 
* '''Issue credits for the days when:''' - select any combination (one, few, all, none) of the bellow:
* '''Issue credits for the days when:''' - select any combination (one, few, all, none) of the bellow:
** '''The customer was blocked'''.
** '''The customer was blocked'''.
** '''The service was suspended'''.
** '''The service was suspended'''.
** '''No funds were available'''. <br><br>
** '''No funds were available'''.
 
* ''' Skip credits, charge in full:''' - select any combination (one, few, all, none) of the bellow:
** '''For the first billing period'''.
** '''For the regular billing periods'''.
** ''' For the last billing period'''.<br><br>


=== Billing Settings ===
=== Billing Settings ===


NOTE: Billing Settings in the Charge Plan are applied only to Flat Rate Plans and Custom Service Subscriptions. DID Billing Settings in the DID Subscription comes from DID Buying and Selling Pricing Groups.
In other words - Billing Settings in the Charge Plan will not be applied to the DID Subscriptions.
<br><br>
* '''Settings From''' - Choose from where to apply Billing Settings. Options are DID Selling Pricing Group or Selected Charge Plan. Applies only to DID type Subscription. Based on [[M4_Settings#SIP_Trunking| Global 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 80: Line 116:
* '''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.371xxxxxx will be rounded to 5.38.
** '''Up'''-  round to higher value. If the precision is 2 decimals 5.371xxxxxx will be rounded to 5.38.
** '''Down''' - round to lover value. If precision is 2 decimals 5.379xxxxxx will be rounded to 5.37.
** '''Down''' - round to lover value. If the precision is 2 decimals 5.379xxxxxx 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).<br><br>
** '''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>


= Edit Subscription =
Same settings except you can disable or enable the Subscription by pressing Disable/Enable button.
[[File:M4_subs_disable_button.png]]
[[File:M4_subs_enable_button.png]]
[[File:M4_subs_close_button.png]]
= Close Subscription =
To close a subscription it is needed to choose Close Type, Close Date end change the Invoice Line name if needed. <br>
If the Invoice Line name is not changed, the system will put the default name: Money return for closed subscription. <br>
[[File:Close subscription.png]]
Enter the same window again to cancel closing the subscription. <br><br>
[[File:Cancel_close_subscription.png]]
= Refine Results =
Refine Results allows filtering Subscriptions by selected parameters.
Parameters:
: User, Period, Status, Service Name (support wildcard %), Activation Date, Finish Date.
[[File:M4_subs_refine_result.png]]
=Invoices=
When generating an invoice for a specific date range, all subscription charges incurred within that period will be listed on the invoice.<br><br>
'''Example when Subscription charges are applied in advance:'''
A monthly Subscription is activated and charged on 2024-01-01 (charged in advance for January). It will be reflected in the Invoice generated for the period 2024-01-01 - 2024-01-31.
'''Example when Subscription charges are applied on period end:'''
A monthly Subscription is activated on 2024-01-01 and charged on 2024-01-31 (end of January). It will be reflected in the Invoice generated for the period 2024-01-01 - 2024-01-31.
==Invoice data==
Subscription data in the Invoice will be constructed from various Subscription/Charge Plan settings. The format is:
X - Y (Z)
* X - Name visible to end user
* Y - Invoice Line Name
* Z - charge period
An example of two DID subscriptions:
[[File:M4_subscription_invoice.png]]
The first two lines in this Invoice show calls to specific DIDs. These lines are automatically prefixed with "DID:".
The next lines are for DID Subscriptions.
* '''DID 37000000001''' is taken from Subscription/Charge Plan field '''Name visible to end user'''.
* '''Activation fee''' is taken from Subscription/Charge Plan field '''Invoice Line Name''' (under Activation Fee).
* '''2024-02-23 - 2024-03-22''' is Subscription charge period.
Similar lines are included for the Periodic Fee.
==Group by Charge Plan==
Subscription Invoice lines can be grouped by Charge Plan when option [https://wiki.kolmisoft.com/index.php/M4_Settings#Invoices Group Subscriptions by Charge Plan] is enabled.
In this case, all Subscription lines are grouped into a single line, and the Invoice will show value from the Charge Plan field '''Name visible to end user''':
[[File:M4_subscription_invoice_grouped_by_charge_plan.png]]
==Group DID Calls into single line==
DID calls can also be grouped into single line when option [https://wiki.kolmisoft.com/index.php/M4_Settings#Invoices Group DID Calls into single line] is enabled.
In this case, all DID calls will be grouped into a single line, and the Invoice will show value from a field defined under [https://wiki.kolmisoft.com/index.php/M4_Settings#Invoices Group DID Calls into single line] setting.
[[File:M4_subscription_invoice_grouped_by_charge_plan_and_dids.png]]


<br><br>
<br><br>
== See also ==
 
= See also =
* [[M4 Subscriptions|Subscriptions]]
* [[M4 Subscriptions|Subscriptions]]
** [[M4 Charge Plans|Charge Plans]]
** [[M4 Charge Plans|Charge Plans]]

Latest revision as of 12:50, 26 February 2024






Subscription describes HOW MUCH, HOW (in what terms), for WHAT Service we will charge? And WHO will pay?

Usage

Go to ACCOUNTING –> Subscriptions:

M4 subscriptions.png

Here you can see the list of Subscriptions and create new Subscriptions.

M4 subscriptions list.png

Add New Subscriptions

Type: DID

M4 add new subscription.png

Type: Flat-Rate

M4 add new subscription flat rate.png

New Subscription

  • User - choose a User for the Subscription.
  • Type - select the type of Subscription.
    • DID - if the Subscription Type is "DID," search for and subscribe using Tags, DID number, or Destination.
    • Flat-Rate - if the Subscription Type is "Flat-Rate," select a plan from the drop-down menu.
    • Custom Service - if the Subscription Type is "Custom Service," select a service from the drop-down menu.
  • Discount - apply a discount to affect Activation and Periodic Fees.
    • Activation Fee - discount for Activation Fee.
    • Periodic Fee - discount for Periodic Fee.
  • Start Date - the date when the Subscription becomes active.
  • Finish Date - the date when the Subscription ends.
  • DID Status on Finish Date - Available for DID Subscriptions. Sets DID status when Subscription is finished. Possible values are: Free, Blocked, Reserved, and Archived.
  • Until canceled? - If checked, the Subscription remains active until manually closed.
  • Charge Plan - select the Charge Plan. More information can be found here.

General Settings

  • Periodic Charge - the Susbcription will be charged periodically.
  • One-Time Charge - the Subscription will be charged only once.
  • Charge Plan Name - Charge Plan Name.
  • Charge Plan Name visible to end user - Charge Plan Name visible to User. This name will be included in Invoices.
  • Description - Subscription description.

Period Settings

  • Period - the period can be in hours, days, months or years.
  • Align Period - More information can be found here.
    • 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 the option disabled May month will be charged for (31-27)/31 * 10 = 1.29 EUR.
    • 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 Charge Plan for a User.
  • Try to renew for - hours(s) or days(s) which we will try to renew Charge Plan.
  • Apply subscription Charges: - how to apply subscription Charges. Available Options:
    • At the end of the Period.
    • In advance.
      • Periods in advance - how many periods charge in advance. Default: 1.
    • Progressively (every day).
  • 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:
      • Admin
      • User

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.

Cancellation Settings

  • Minimum Subscription Period - a period in days/weeks/months/years for which Customer will be charged if a subscription is canceled earlier. Depends on the Period Settings.
  • Early Cancellation Penalty - Fixed or Remaining Subscription charges. Set the amount if fixed is selected.
  • Invoice Line Name - name in Invoice for a subscription cancelation.

Credits

  • Issue credits for the days when: - select any combination (one, few, all, none) of the bellow:
    • The customer was blocked.
    • The service was suspended.
    • No funds were available.
  • Skip credits, charge in full: - select any combination (one, few, all, none) of the bellow:
    • For the first billing period.
    • For the regular billing periods.
    • For the last billing period.

Billing Settings

NOTE: Billing Settings in the Charge Plan are applied only to Flat Rate Plans and Custom Service Subscriptions. DID Billing Settings in the DID Subscription comes from DID Buying and Selling Pricing Groups.

In other words - Billing Settings in the Charge Plan will not be applied to the DID Subscriptions.


  • Settings From - Choose from where to apply Billing Settings. Options are DID Selling Pricing Group or Selected Charge Plan. Applies only to DID type Subscription. Based on Global 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.371xxxxxx will be rounded to 5.38.
    • Down - round to lover value. If the precision is 2 decimals 5.379xxxxxx 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).

Edit Subscription

Same settings except you can disable or enable the Subscription by pressing Disable/Enable button.

M4 subs disable button.png M4 subs enable button.png M4 subs close button.png

Close Subscription

To close a subscription it is needed to choose Close Type, Close Date end change the Invoice Line name if needed.
If the Invoice Line name is not changed, the system will put the default name: Money return for closed subscription.
Close subscription.png

Enter the same window again to cancel closing the subscription.

Cancel close subscription.png

Refine Results

Refine Results allows filtering Subscriptions by selected parameters.

Parameters:

User, Period, Status, Service Name (support wildcard %), Activation Date, Finish Date.

M4 subs refine result.png

Invoices

When generating an invoice for a specific date range, all subscription charges incurred within that period will be listed on the invoice.

Example when Subscription charges are applied in advance:

A monthly Subscription is activated and charged on 2024-01-01 (charged in advance for January). It will be reflected in the Invoice generated for the period 2024-01-01 - 2024-01-31.

Example when Subscription charges are applied on period end:

A monthly Subscription is activated on 2024-01-01 and charged on 2024-01-31 (end of January). It will be reflected in the Invoice generated for the period 2024-01-01 - 2024-01-31.

Invoice data

Subscription data in the Invoice will be constructed from various Subscription/Charge Plan settings. The format is:

X - Y (Z)
  • X - Name visible to end user
  • Y - Invoice Line Name
  • Z - charge period

An example of two DID subscriptions:

M4 subscription invoice.png

The first two lines in this Invoice show calls to specific DIDs. These lines are automatically prefixed with "DID:".

The next lines are for DID Subscriptions.

  • DID 37000000001 is taken from Subscription/Charge Plan field Name visible to end user.
  • Activation fee is taken from Subscription/Charge Plan field Invoice Line Name (under Activation Fee).
  • 2024-02-23 - 2024-03-22 is Subscription charge period.

Similar lines are included for the Periodic Fee.

Group by Charge Plan

Subscription Invoice lines can be grouped by Charge Plan when option Group Subscriptions by Charge Plan is enabled.

In this case, all Subscription lines are grouped into a single line, and the Invoice will show value from the Charge Plan field Name visible to end user:

M4 subscription invoice grouped by charge plan.png

Group DID Calls into single line

DID calls can also be grouped into single line when option Group DID Calls into single line is enabled.

In this case, all DID calls will be grouped into a single line, and the Invoice will show value from a field defined under Group DID Calls into single line setting.

M4 subscription invoice grouped by charge plan and dids.png



See also