Charging
Topics in this document:
To access this section in Monetization, from the Menu, select Business configuration, and click Charging.
Tags
To access this section, click Tags. A paginated list of all tags is shown in a tabular format.
Tags are predominantly used in Monetization for discounting purposes. A tag can be applied to a product as a charge tag, which can be targeted when creating discounts.
Note:
Using a tag is how to create discounts on an invoice level and real-time discounting for each event.Whenever Monetization impacts a resource balance, these impacts also have tags that can be targeted for discounting.
For instance, in the telecommunication industry, a data event originating from Austria can have a tag data_AUS, while an event originating from Slovenia can have a tag data_SVN.
With these tags, you can configure discounts that only apply to one tag, allowing you to discount only a specific usage type.
Four actions/subpages can be performed/viewed under this section, namely:
Create a tag
Under tags, to create a tag, click Create new. Provide a name, code, and type; optionally, add a description.
Note:
The code is a unique identifier of an object. It can be used during integration with the Monetization API.Under the type, the charge or resource tag can be chosen. For more information about the differences between a charge and a resource tag, see Charge vs. Resource tags.
Charge vs. Resource tags
The charge tag is used for products and resource infos in the rate plan. It is used at a higher level in the rate plan, where Monetization can impact multiple resources below the tag.
The resource tag is used at a lower level in the rate plan. It is used in the rate plan details, where Monetization can only impact one resource balance.
Note:
A resource tag and a charge tag can be created and combined while configuring a rate plan, which enables you to narrow down what to discount.Information:
A discount filter can target both the charge and resource tag, which gives extra flexibility.Details tag page
Under tags, to see the full details of a tag, click Details. It contains the following:
- Name
- Code
- Description
- Type
Update tag
Under tags, to update a tag, first, click Details; it shows the details of the tag. Then to update, click Update.
Information:
All information filled out under the create a tag section can be updated except for the Code.Delete tag
Under tags, to delete a tag, click Delete.
Note:
Deleting a tag already used in a product, discount, or rate plan cannot be done. Every particular reference to the tag first has to be deleted.Resources
To access this section, click Resources. A paginated list of all resources is shown in a tabular format.
Information:
This section shows how to create resources in Monetization, for example, monetary resources (e.g., Euro, US Dollar, etc.), free resources (e.g., free SMS, free data, etc.), etc.A resource represents an object in Monetization that can hold a value—for example, a monetary resource with a value of 10.
In addition, a resource can exist as a balance for a customer. A balance is one unique resource value inside a specific balance group.
Balances of a resource are created automatically in Monetization whenever a customer purchases a product or triggers a usage event. For instance, if a plan has a product that grants 100 free minutes. Upon the customer purchasing the plan, a balance of 100 free minutes will be created in the related balance group.
Information:
A balance can also be manually created via the API, which is used more for management than automation.Resources are essential when creating a product catalog because the products a customer can purchase will result in a resource balance impact—for example, charging a customer 100 euros or granting them 100 free credits.
Examples of a resource
Below are five examples of a resource, including their industry.
- Euro — Any industry — It represents the current monetary balance of a customer within the current cycle.
- Free minutes — Telecommunications
- Total consumption kWh — Utility
- Minimum fare fee — Car sharing/Taxis — An helper resource holding the minimum fee that the customer has to pay for every ride
- API calls total — Cloud services — To keep track of how many generated API call events
Note:
A resource balance can increase or decrease due to a customer purchasing a product or generating a usage event. A customer’s balance will be affected whenever they buy a product or use a service that triggers a usage event.Four actions/subpages can be performed/viewed under this section, namely:
Create resource
Under resources, to create a resource, click Create new. It includes mandatory and optional input fields.
The mandatory input fields include the following:
- Name
- Code
- Balance consumption order
- Default value
- Validity period
Note:
The code is a unique identifier of an object. It can be used during integration with the Monetization API.The optional input fields include the following:
- Description
- Temporary
- Currency
- Included on invoice
Note:
The most important resource in Monetization is the monetary resource because it represents a currency that the customer is paying in.Monetary resource
Monetary resource means actual money in Monetization; it represents monetary currency (e.g., euros, dollars, etc.). To create a monetary resource, under create resource, provide a name (e.g., euro), a code (e.g., euro), a description (e.g., euro monetary resource), and a balance consumption order.
For a monetary resource, the earliest start time and earliest expiration time (ESTEET) is configured for the balance consumption order because the oldest balance should be consumed first.
Typically, the default value is set to 0. However, it can be modified to either a positive or negative value, for example, 100. Whenever Monetization creates a balance for the resource initially, it starts with the default value.
Tip:
It is a good practice not to change the default value of a free resource from zero because the default value will be applied globally to all customers for all the created resource balances. Instead, create a product that will grant some amount of free resources to the customer.
Typically, Monetization basis free resources on the customer plan. One customer can have 1GB of free data, while another has 2GB. Hence, create a product for that plan, which will grant the correct amount depending on the plan.
Information:
A resource can be created whose balance represents a counter that will count downward toward zero. In that case, the default value can be set to any positive number.
Instead of initially setting the resource balance with the purchase of a product, the resource balance will be set to the default value of the resource upon the creation of the resource balance. For more information about the usefulness, see helper resources.
To make the resource a temporary resource, use the Temporary toggle switch to enable/disable. Enabling this feature means that the resource will return to the default value immediately after Monetization completes rating. It is used mainly for helper resources.
By default, a resource is always valid from the day it is created to an infinite period. However, it can be configured to expire sometime in the future. Typically, a monetary resource should have infinite validity.
Note:
A resource becomes a monetary resource when a currency is assigned to the resource. In contrast, for a non-monetary resource, see non-monetary resource.To include the resource on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.
Note:
Only include the information needed on the invoice for performance optimization.Balance consumption order
The balance consumption order specifies the order to which the resource balance should be impacted when multiple balances of the same resource exist in a balance group.
For instance, a customer balance group has the following:
- 100 free minutes valid from the 1st of January to the 15th of February
- 50 free minutes valid from the 1st of February to the 1st of March
Assume today is the 10th of February; both balances are valid. Therefore, the customer currently has 150 free minutes in total. The customer then generates an event for 120 free minutes; the balance consumption order configuration decides which balance should be consumed first based on the validity period.
If the balance consumption order is set to ESTEET, the customer will end up with 30 free minutes, valid from the 1st of February to the 1st of March. However, suppose the balance consumption order is set to consume the latest resource first. In that case, the customer will end up with 30 free minutes valid from the 1st of January to the 15th of February.
Explanation of some terms
- EST
- Configuring the balance consumption order to earliest start time (EST) means that the balance with the earliest validity start time is used first.
- LST
- Configuring the balance consumption order to latest start time (LST) means that the balance with the latest validity start time is used first.
- EET
- Configuring the balance consumption order to earliest expiration time (EET) means that the balance with the earliest validity end time is used first.
- LET
- Configuring the balance consumption order to latest expiration time (LET) means that the balance with the latest validity end time is used first.
- ESTLET
- Configuring the balance consumption order to earliest start time and latest expiration time (ESTLET) means that the balance with the earliest validity start time is used first. If multiple balances have the same validity start time, the one with the latest end time is used first.
- ESTEET
- Configuring the balance consumption order to earliest start time and earliest expiration time (ESTEET) means that the balance with the earliest validity start time is used first. If multiple balances have the same validity start time, the one with the earliest end time is used first.
Tip:
The ESTEET should be used as the default balance consumption order.- LSTEET
- Configuring the balance consumption order to latest start time and earliest expiration time (LSTEET) means that the balance with the latest validity start time is used first. If multiple balances have the same validity start time, the one with the earliest end time is used first.
- LSTLET
- Configuring the balance consumption order to latest start time and latest expiration time (LSTLET) means that the balance with the latest validity start time is used first. If multiple balances have the same validity start time, the one with the latest end time is used first.
- EETEST
- Configuring the balance consumption order to earliest expiration time and earliest start time (EETEST) means that the balance with the earliest validity end time is used first. If multiple balances have the same validity end time, the one with the earliest start time is used first.
- EETLST
- Configuring the balance consumption order to earliest expiration time and latest start time (EETLST) means that the balance with the earliest validity end time is used first. If multiple balances have the same validity end time, the one with the latest start time is used first.
- LETEST
- Configuring the balance consumption order to latest expiration time and earliest start time (LETEST) means that the balance with the latest validity end time is used first. If multiple balances have the same validity end time, the one with the earliest start time is used first.
- LETLST
- Configuring the balance consumption order to latest expiration time and latest start time (LETLST) means that the balance with the latest validity end time is used first. If multiple balances have the same validity end time, the one with the latest start time is used first.
Helper resources
A helper resource is not directly relevant to the customer; however, Monetization uses it for rating. For example, a counter resource, which Monetization uses to keep track of something.
Example of a helper resource
Assume a resource MBs used in a session to track how many MBs the customer has used in one data session/event. A helper resource in the form of a counter resource can be used.
If the pricing is expected to change after the customer has consumed 10MBs within one session, that is, there is multi-tier pricing, immediately Monetization receives a data event, it will be rated according to the rate plan. The counter resource can track how many quantities the customer has used to know when to start rating with a different price.
After the single event has been rated, the helper resource MBs used in a session in the form of a counter resource will be reset to zero for it to be ready for the next event.
Note:
For a resource to reset to its default value after each rating, the Temporary toggle switch should be enabled.Non-monetary resource
A non-monetary resource does not have a monetary value; hence, it is not treated as money. Examples of non-monetary resources can include free data, free SMS, etc.
Information:
To learn how to generally create a resource, see monetary resource.Note:
A non-monetary resource should not be given a currency. Assigning a currency to the resource turns it into a monetary resource.Details resource page
Under resources, to see the full details of a resource, click Details. It contains the following:
- Status — a resource with an active status means the resource is still valid.
- Name
- Code
- Description
- Balance consumption order
- Default value
- Type (Standard or Temporary)
- Valid from
- Valid to
- Currency (if any)
- Included on invoice
Update resource
Under resources, to update a resource, first, click Details; it shows the details of the resource. Then to update, click Update.
Information:
All information filled out under the create resource section can be updated except for the Code.Delete resource
Under resources, to delete a resource, click Delete.
Note:
Deleting a resource already used in other parts of Monetization cannot be done. Every particular reference to the resource first has to be deleted.Thresholds
To access this section, click Thresholds. A paginated list of all thresholds is shown in a tabular format.
A threshold is a configured value that can trigger a notification whenever a resource balance exceeds a threshold defined on the credit limit and linked to the resource by a credit profile.
Four actions/subpages can be performed/viewed under this section, namely:
Create threshold
Under thresholds, to create a threshold, click Create new. It includes mandatory and optional input fields.
The mandatory fields include the following:
- Name (e.g., T_200)
- Code (e.g., T_200)
- Type (amount or percentage)
- Value (e.g., 200)
Note:
The code is a unique identifier of an object. It can be used during integration with the Monetization API.The optional field includes:
- Description (e.g., threshold for 200)
A threshold configured as an amount means the value is fixed—for example, 200. Therefore, when the balance exceeds 200, it will trigger a notification.
Note:
A threshold value configured as an amount can also be negative.A threshold configured as a percentage means the value is relative to another resource balance. For instance, assume two balances:
| Resource name | Balance |
|---|---|
| Granted free MBs | 1000 |
| Free MBs | 900 |
If a percentage threshold for Free MBs is configured to be 80% of the Granted free MBs balance, then the threshold will trigger at 800.
Tip:
The percentage threshold is useful because it can change the value based on a different resource balance—allowing for more flexibility on the customer level. While the amount threshold is always constant based on the configured value.Information:
Once a threshold is created, it will not be connected to anything, but rather it is an object that exists in Monetization that can be used when creating a credit limit.Details threshold page
Under thresholds, to see the full details of a threshold, click Details. It contains the following:
- Name
- Code
- Description
- Type
- Value
Update threshold
Under thresholds, to update a threshold, first, click Details; it shows the details of the threshold. Then to update, click Update.
Information:
All information filled out under the create threshold section can be updated except for the Code.Delete threshold
Under thresholds, to delete a threshold, click Delete.
Note:
Deleting a threshold already linked to a credit limit cannot be done. Every particular reference to the threshold first has to be deleted.Notifications
Monetization triggers a notification whenever a balance of a specific resource exceeds or falls below a threshold. The threshold is linked to a credit limit and configured for a particular resource by a credit profile.
The notifications can be seen in Monetization under the customer account page. For more information, see Notifications.
Credit limits
To access this section, click Credit limits. A paginated list of all credit limits is shown in a tabular format.
A credit limit can be used to restrict how far a customer can use a resource in terms of positive or negative value. You can also add multiple thresholds, which a customer can breach as they go over the configured value.
It describes a resource balance’s minimum and maximum limits and which thresholds can be triggered when breached.
Four actions/subpages can be performed/viewed under this section, namely:
Create a credit limit
Under credit limits, to create a credit limit, click Create new. It includes mandatory and optional input fields.
The mandatory fields include the following:
- Name
- Code
- Start
- Stop
Note:
The code is a unique identifier of an object. It can be used during integration with the Monetization API.The optional fields include the following:
- Description
- Thresholds
Multiple thresholds can be added. For example, assume a credit limit with a threshold value of 200; therefore, whenever the resource balance exceeds 200, it will trigger a notification.
Note:
The Start and Stop fields represent the minimum and maximum values, respectively, one resource balance can have.The Start and Stop fields can be configured as either positive or negative numbers. In addition, the Start and Stop fields can also be configured to No minimum or No maximum, which is more user-friendly, by clicking Pick value.
The No minimum and No maximum value means that the value can be unlimited, as it goes from minus infinite to plus infinite.
Tip:
A prepaid monetary resource should have its Stop value configured to zero. This would enable the resource balance not to exceed zero.
This is typical because prepaid customers can only use the service(s) while they have money available. Therefore, it does not make sense to let their monetary balance fall below zero.
In addition, if the limit is set to zero, then Monetization can tell when the money ran out and will no longer rate events.
Note:
It is impossible to bring a resource balance outside of the credit limit Start and Stop values. In addition, the service the customer consumes can be disabled as soon as the resource limit is reached—for example, a prepaid customer who runs out of money.Details credit limit page
Under credit limits, to see the full details of a credit limit, click Details. It contains the following:
- Name
- Code
- Description
- Thresholds
- Start
- Stop
Update credit limit
Under credit limits, to update a credit limit, first, click Details; it shows the details of the credit limit. Then to update, click Update.
Information:
All information filled out under the create a credit limit section can be updated except for the Code.Delete credit limit
To delete a credit limit, click Delete.
Note:
Deleting a credit limit already linked to a credit profile cannot be done. Every particular reference to the credit limit first has to be deleted.Credit profiles
To access this section, click Credit profiles. A paginated list of all credit profiles is shown in a tabular format.
A credit profile links a credit limit to a particular resource for a specific payment type. For example, how the euro (monetary) resource has to behave, which credit limit should it use when it is available as a balance on a customer’s account.
Four actions/subpages can be performed/viewed under this section, namely:
Create a credit profile
Under credit profiles, to create a credit profile, click Create new. It includes mandatory and optional input fields.
The mandatory fields include the following:
- Name
- Code
- Payment type
- Resource
- Credit limit
Note:
The code is a unique identifier of an object. It can be used during integration with the Monetization API.The optional field includes:
- Description
Note:
A credit profile must be created for each payment type because it describes balance behaviours in relation to a payment type. If non-existent, then the balance can not be created.Information:
Configuring a credit profile will enable each resource to be given a description that depicts how it will be limited based on the payment type of the customer.For a postpaid payment type
For a postpaid payment type, the credit limit with a Start value of No minimum and a Stop value of No maximum is recommended.
This means the resource that belongs to the customer can either be a negative value (because the customer was given some credit) or a positive value (because the customer will owe something).
For a pay-now payment type
The credit limit with a Start value of No minimum and a Stop value of No maximum is recommended for a pay-now payment type.
This means the resource that belongs to the customer can either be a negative value (because the customer was given some credit) or a positive value (because the customer will owe something).
For a prepaid payment type
For prepaid payment type, it is recommended that the credit limit with a Start value of No minimum and a Stop value of 0 should be chosen because the customer balance should not exceed zero.
For instance, assume a prepaid customer purchases a product that offers 100 euros, which is a monetary resource. It will be shown in the customer’s balance as -100 euros of credit. The customer can consume the resource and would not owe anything.
However, as they continue consuming the resource, the balance will reduce until it reaches zero, which indicates that the customer has exhausted the resource.
Details credit profile page
Under credit profiles, to see the full details of a credit profile, click Details. It contains the following:
- Name
- Code
- Description
- Payment type
- Credit limit
- Resource
Update credit profile
Under credit profiles, to update a credit profile, first, click Details; it shows the details of the credit profile. Then to update, click Update.
Information:
All information filled out under the create a credit profile section can be updated except for the Code.Delete credit profile
Under credit profiles, to delete a credit profile, click Delete.
Event types
To access this section, click Event types. A paginated list of all event types is shown in a tabular format.
An event type represents a time interval in Monetization. It is created to be configured for a recurring product to determine how the product will renew. It is also configured for a customer to determine how frequently the customer will be charged.
Different cycles can be configured for an event type. For instance, monthly cycle, three months cycle, semi-annual cycle, annual cycle, etc.
Four actions/subpages can be performed/viewed under this section, namely:
Create event type
Under event types, to create an event type, click Create new. The name, code, interval unit, interval duration, and interval time are required, while the description is optional.
The interval unit constitutes three values:
- Days
- Weeks
- Months
The interval duration specifies the length of time given to the interval unit—for example, six months; the interval time, which default value is 12:00 AM.
For instance, given the below table:
| Interval unit | Interval duration | Interval time |
|---|---|---|
| Months | 6 | 12:00 AM |
If a recurring product is given the above event type, it means that the product will renew every six months at 12:00 AM. Similarly, configuring the event type for a customer under the billing profile means that the customer will be charged every six months at 12:00 AM.
Details event type page
Under event types, to see the full details of an event type, click Details. It contains the following:
- Name
- Code
- Description
- Interval unit
- Interval duration
- Interval time
Update event type
Under event types, to update an event type, first, click Details; it shows the details of the event type. Then to update, click Update.
Information:
All information filled out under the create event type section can be updated except for the Code.Delete event type
Under event types, to delete an event type, click Delete.
Note:
Deleting an event type already used in other parts of Monetization cannot be done. Every particular reference to the event type first has to be deleted.Rounding modes
To access this section, click Rounding modes.
Rounding modes are configured for each site to determine how many decimal places to round the calculations made during different stages of rating.
There are four distinct components to applying a scale for, which are:
- Rating
- Discounting
- Taxation
- Billing
Whenever one of these four components gets triggered in Monetization, the rounding mode is applied to round the values to the configured decimal places.
The Scale refers to a number that denotes the number of decimal places. The Mode can be configured to Half Up or Half Down. For example, if configured to be Half Up, a value of 7.5 will be rounded to 8, while if configured to be Half Down, a value of 7.5 will be rounded to 7.
