This section is relevant for Prepaid Customers/Subscribers only.
¶ Plans
¶ Prepaid Plans screen usage
Prepaid subscribers plans.
Prepaid subscribers are not charged for their plans.
A plan is a kind of membership, and any subscriber must have one.
The plan determines a prepaid subscriber behaviour - restrictions, permissions, amounts/volumes, periods, thresholds, notifications etc.
¶ Prepaid Plans screen fields
Main Prepaid Plans screen - Automatically shows a table with all the predefined customer plans.
What is the information shown in the Prepaid Plans table ?
Title: plan’s name - to be presented in the bill.
Key: unique plan’s key - for use by the system - Not editable.
(External) Code: reference to the old system - identifier for the user in case of API usage.
How to search for an existing plan ?
Plans can be found by searching a value in the “Search for…” input field above the Plans table.
The value will be searched by a specific field that should be checked in “Search in fields” drop down list button.
Press Enter or the magnifier (search) button to activate the search.
The eraser button next to the magnifier (search) button is for resetting “Search for…” input field.
How to edit an existing plan ?
Prepaid Plans values can be edited by pressing the pencil on the right side of each line in the plans table.
Edit Prepaid Plan screen - Filled with the selected plan’s data when in edit mode.
What are the fields shown in the Edit Prepaid Plan screen ?
See details below in tabs explain.
What is the use of each tab in the Edit Prepaid Plan screen ?
Details tab:
Usage:
Define the Plan’s name, code and key.
Fields:
Title: plan’s name - to be presented in the bill.
Key: unique plan’s key - for use by the system - this field exist and editable only in edit mode.
External Code: reference to the old system - identifier for the user in case of API usage.
Override Product Price tab:
Usage:
Changing the market (original) price of a selected product for subscriber who is registered on a specific plan. See the Product Pricing section to learn more about editing a product.
Fields:
In the “Select Products to Override Price” panel, start typing (auto completion) the product you want to use. Select from the predefined products list.
The product definitions panel will be added automatically.
The product is now available for editing, the same way as products in the Products screen.
Notifications:
Usage:
Define thresholds and message for sending notification to the customers who have the current plan, when reaching the lower limit of s specific bucket (balance). Each bucket has it’s own limitation (if defined).
Fields:
In the “Select prepaid bucket” panel, start typing (auto completion) the bucket you want to use. Select from the predefined buckets list.
The bucket notification panel will be added automatically.
The bucket notification is now available for editing.
Value: when the balance/amount/volume in the bucket reach this value - a notification will be sent to the C subscriber.
Type: the notification sending method. Currently for API use only, by the B customer/carrier.
Message: the message that will be sent by the B customer/carrier the the C subscriber.
Blocked Products:
Usage:
Products (destinations) listed in this tab will be blocked for use by the C subscribers who have this plan.
Fields:
In the “Blocked products” panel, start typing (auto completion) the product you want to block. Select from the predefined products list.
The product that should be blocked will be added automatically.
Charging Limits: (name should be changed to Recharge)
Usage:
Define the maximum amount/volume that can be recharged in a bucket.
Exceeding this amount/volume will cause a loss of the exceeded amount/volume.
When no bucket is defined there will be no limitations.
“0” value will prevent any recharge to the bucket.
Fields:
In the “Select prepaid bucket” panel, start typing (auto completion) the bucket you want to limit. Select from the predefined buckets list.
The bucket that should be limit will be added automatically.
Fill the limitation amount/volume.
How can I add new plan ?
Press the “Add New” button on the upper right side of the Prepaid Plans table in the main Prepaid Plans screen.
Fill up all the fields as described in “What is the use of each tab in the Edit Prepaid Plan screen” section, and press Save.
¶ Charging
¶ Prepaid Buckets Group screen usage
Build charging plans for prepaid subscribers.
Charging plan contains package of bucket(s) - at least one bucket. Recharge of buckets to a subscriber can be done by recharge the requested amount/volume directly to a bucket or by recharge a charging plan that contains one or more buckets.
Each bucket in the charging plan has a value for the amount/volume the name and id of the bucket and a validity period - usually in days. The amount/volume in the bucket will be valid from the recharge date till the date at the valid period (recharge date + validity period).
Bucket is also called Balance.
¶ Prepaid Buckets Group screen fields
Main Prepaid Charging Plans screen - Automatically shows a table with all the predefined charging plans.
What is the information shown in the Prepaid Charging Plans table ?
Title: charging plan’s name for identification.
Key: unique plan’s key - for use by the system - Not editable.
External Code: reference to the old system - identifier for the user in case of API usage.
Operation: Type of action to apply on a bucket -
- Set: override all values including amount/volume, in existing bucket or create new bucket if not exist. Bucket’s expiration date will be the latest between the existing expiration date and the new expiration set by the recharge.
- Increment: will add the new recharge amount/volume to the existing bucket amount/volume or create new bucket if not exist. Bucket’s expiration date will be the latest between the existing expiration date and the new expiration set by the recharge.
- New: create new bucket unconditional (even if there is existing bucket or not).
Charging value: the charging plan code. Represent the charging plan.
How to search for an existing charging plan ?
Charging plans can be found by searching a value in the “Search for…” input field above the Charging Plans table. The value will be searched by a specific field that should be checked in “Search in fields” drop down list button.
Press Enter or the magnifier (search) button to activate the search.
The eraser button next to the magnifier (search) button is for resetting “Search for…” input field.
How to edit an existing charging plan ?
Charging plans values can be edited by pressing the pencil on the right side of each line in the plans table.
Edit Charging Plan screen - Filled with the selected charging plan’s data when in edit mode.
What are the fields shown in the Edit Charging Plan screen ?
See details below in tabs explain.
What is the use of each tab in the Edit Charging Plan screen ?
Details tab:
Usage:
Define the Plan’s name, code and key.
Fields:
Title: charging plan’s name for identification.
Key: unique charing plan’s key - for use by the system - this field exist and editable only in edit mode.
External Code: reference to the old system - identifier for the user in case of API usage.
Operation: Type of action to apply on a bucket -
- Set: override all values including amount/volume, in existing bucket or create new bucket if not exist. Bucket’s expiration date will be the latest between the existing expiration date and the new expiration set by the recharge.
- Increment: will add the new recharge amount/volume to the existing bucket amount/volume or create new bucket if not exist. Bucket’s expiration date will be the latest between the existing expiration date and the new expiration set by the recharge.
- New: create new bucket unconditional (even if there is existing bucket or not).
Charging value: the charging plan code. Represent the charging plan.
Prepaid buckets tab:
Usage:
Define the buckets and its attributes in the charging plan.
Fields:
In the “Select prepaid bucket” panel, start typing (auto completion) the bucket you want to add. Select from the predefined buckets list.
The selected bucket will be added automatically.
You can add one or all of the predefined buckets to the list.
Fill all the requested fields in each bucket.
Volume: the amount/value to recharge for the subscriber’s bucket. We use negative values for accounting reasons. Each use from the bucket’s volume will reduce the negative - inclining direction towards “0”, which means no volume/units credit left in the bucket and therefore won’t be given allowance to execute an activity.
Duration: the period that this bucket will be valid starting from the moment of recharge. The number in the duration will be added to the start date-time in order to determine the end date-time.
- Left input field: the amount/number of units from the type that should be selected from the right dropdown field, in order to add to the start date-time and define the end date-time.
- Right dropdown field: the type of the unit amount/number that should be selected, in order to add to the start date-time and define the end date-time.
How can I add a new charging plan ?
Press the “Add New” button on the upper right side of the Charging Plans table in the main Prepaid Charging Plans screen.
Fill up all the fields as described in “What is the use of each tab in the Edit Charging Plan screen” section, and press Save.
¶ Buckets
¶ Prepaid Buckets screen usage
Build all available buckets in the system.
Buckets built to use as a different logical wallet/balance - each bucket is used for a specific, different activity (e.g bucket for sms, calls {inbound, outbound, etc.}, data, etc.). This buckets have a limited time period for use - after this time period, the bucket will not be available for any use.
Core balance bucket is exceptional and consist of currency units (not volume or duration like the others), and therefore can be used for all type of activities. This backed has no time limitation.
Buckets can be shared between all C subscribers within a B customer account, or be unlimited.
Buckets can be limited to use for specific products for a certain plan (e.g restrict the sms bucket for “unique_plan_#01”, so it would be able to send sms only to products/destinations that starts with 123…).
The use of buckets can be prioritized.
¶ Prepaid Buckets screen fields
Main Prepaid Buckets screen - Automatically shows a table with all the predefined buckets.
What is the information shown in the Prepaid Charging Plans table ?
Name: prepaid bucket’s name for identification.
Charging by: the charging of each bucket can be by one of the following (Indicating the system how to rate each bucket/activity):
usagev: for activity involves volume, duration, amount/unit.
cost: for activity involves currency for a specific bucket.
total_cost: currency bucket for any activity.
Charging by usaget: allocating the relevant bucket to rate and charge an activity (call, sms, data, etc.)
Priority: usage prioritization between buckets (e.g use bonus bucket before calls bucket before core balance bucket). Prioritization defined by a number. The highest will be the 1st.
How to search for an existing bucket ?
Buckets can be found by searching a value in the “Search for…” input field above the Prepaid Buckets table. The value will be searched by a specific field that should be checked in “Search in fields” drop down list button.
Press Enter or the magnifier (search) button to activate the search.
The eraser button next to the magnifier (search) button is for resetting “Search for…” input field.
How to edit an existing bucket ?
Buckets values can be edited by pressing the pencil on the right side of each line in the plans table.
Edit Prepaid Buckets screen - Filled with the selected bucket’s data when in edit mode.
What are the fields shown in the Edit Prepaid Buckets screen ?
See details below in tabs explain.
What is the use of each tab in the Edit Prepaid Bucket screen ?
Details tab:
Usage:
Define the bucket’s details as explained in Usage and Fields.
Fields:
Name: prepaid bucket’s name for identification.
External ID: Id that will be used by 3rd party system to charge the bucket.
Priority: usage prioritization between buckets (e.g use bonus bucket before calls bucket before core balance bucket). Prioritization defined by a number. The highest will be the 1st.
Charging by: the charging of each bucket can be by one of the following (Indicating the system how to rate each bucket/activity):
usagev: for activity involves volume, duration, amount/unit.
cost: for activity involves currency for a specific bucket.
total_cost: currency bucket for any activity.
Usage type: allocating the relevant bucket to rate and charge an activity (call, sms, data, etc.)
Shared bucket: the bucket will be shared by all subscribers associated with an account.
Unlimited: change the bucket behaviour so it won’t be limited by time period (like Core Balance).
Limited Products tab:
Usage:
Define the bucket’s use limitations by plan and product/destination (e.g restrict the sms bucket for “unique_plan_#01”, so it would be able to send sms only to products/destinations that starts with 123…).
Allow specific products (destinations) for a specific customer plan (C subscriber) in a specific bucket. In case where no limitations defined - all products (destinations) are allowed in this bucket. If BASE is defined with specific products in a bucket - all C subscribers will be able to use only those specific products in this bucket. BASE in this case is equivalent to market limitations on a bucket.
Fields:
In the upper panel, start typing (auto completion) the prepaid plan you want to add. Select from the predefined prepaid plans list.
In the new “PLAN_NAME” panel, start typing (auto completion) the product(s) you want to add. Select from the predefined prepaid plans list.
Save.
How can I add a new bucket ?
Press the “Add New” button on the upper right side of the Prepaid Buckets table in the main Prepaid Buckets screen.
Fill up all the fields as described in “What is the use of each tab in the Edit Prepaid Bucket screen” section, and press Save.