Service Plan

Contents

  1. 1 Service Plan
  2. 2 Service Item
    1. 2.1 Minute Buckets
      1. 2.1.1 Tax Items
  3. 3 Service Record
    1. 3.1 Service Item Category

Service Plan

Field type Descriptions
Plan Name varchar Name of the Service Plan
<Plan Name> is unique within each domain, but can be re-used in different domain.
Plan Domain varchar Domain that the Service Plan belong to
<Plan Name>@<Plan Domain> uniquely identify a specific Servie Plan in the system.
Debit Account
 yes or no
 To specify whether account should be debited by the Service Charges
Charge Period varchar The period, e.g. 1 week, 1 month, that the charge associated with the Service Plan should be applied.
Description varchar General description of the Service Plan
Next Plan Name
 varchar Name of the Next Service Plan to chain to
Next Plan Domain
 varchar Domain of the Next Service Plan to chain to


Service Item

This is a list of service item belonging to all the Service Plan

Field type Descriptions
Plan Name varchar Name of the Service Plan that this Service Item belong to
Plan Domain varchar Domain that this Service item belong to
Item Category varchar See Service Item Category
Item Name varchar Name of the service item, e.g. VMail, Monthly Subscription
Item Parameter varchar Parameter specific to the Item, e.g. # minutes for Minute Bucket
Default Count double Default count of the service item.
Optional Service Item MUST have "0" Default Count, and election of such are explicitly specified in Service Item Subscription table.
Item Unit varchar e.g. month, line
Unit Charge double Charge per unit
Tax double Tax rate for this service item
Item Description varchar General description of the item

Note

  • All charges for Service Item are for the next period
  • Need special handling for 1st and last period

Minute Buckets

Minute Buckets is a special Service Item referenced by the Bill Generator.

  • The Minute Bucket Service Item defines the Bucket ID and Amount of Minutes in the bucket
  • Bucket window is with respect to the Service Plan Period
  • Charges and Bucket for 1st and last Service Plan Period are pro-rated
  • CDR entries are included in a bucket based on their Release Time
  • Charges for CDR entries below the bucket rim will be fully credited
  • CDR entries straddling the bucket rim will be fully charged

Field type Descriptions
Plan Name varchar Name of the Service Plan that this Service Item belong to
Plan Domain varchar Domain that this Service item belong to
Item Category varchar "buk"
Item Name varchar Name of the service item, e.g. 500 Minute Bucket
Item Parameter varchar <bucket id>:<# minutes in bucket>, e.g. D:500 for domestic 500 minutes
Item Count double Total minutes in bucket X = <Item Count> * <# minutes in bucket X>
Item Unit varchar e.g. 500 minutes
Unit Charge double Charge per bucket count
Tax double Tax rate for this service item
Item Description varchar General description of the item


Tax Items

Tax Items in a service plan defines Non-Usage Tax, Usage Tax and Usage Charge Tax
  • Tax Item defines the Tax ID and the associated Tax
  • Non-Usage Tax is a fix rate tax applied to each Service Period
  • Usage Tax applies tax proportional to the amount of minutes usage during each Service Period
  • Usage Charge Tax applies tax proportional to the total usage charge during each Service Period

Service Record

Service Record register all service charges, such as

  • Recurrent Monthly Service Plan items
  • Adjustment to Account
  • Payment Received with Total and Date Received


Field type Descriptions
Account User varchar <user> component of the account.
<Account User>@<Account Domain> together uniquely identify the user in the system.
<Account User>=="domain" denotes a summary service charge applied to the domain.
<Account User> must not be "*" for this table.
Account Domain varchar <domain> component of the account.
Plan Name varchar Name of the service plan, e.g. Basic VoIP
Item Category varchar See Service Item Category
Item Name varchar Name of the service item, e.g. VMail, Monthly Subscription
Item Count int Count of the service item
Item Unit varchar e.g. month, line
Unit Charge double Charge per unit
Tax double Tax
Total Charge double Total charge
Charge Date date Date that the charges was incurred
Charge Interval
 		varchar
The period, e.g. 1 week, 1 month, that the charge was inccured
From Date
date
The date that the Charge Interval begin (inclusive)
To Date
date
The date that the Charge Interval end (exclusive)
Time Recorded datetime Date and Time that the charges was recorded
Account Debited 'yes' or 'no'
 Tag whether this charge has already been subtracted from the user's account balance


Service Item Category

Category Descriptions
adj Adjustment to account balance
ctx Tax applied to the Usage Charge before credit from Minute bucket
buk Minute Bucket
nrc Non Recurrent Charge
pmt Payment received
srv Recurrent Service
tax Tax applied to account
utx Tax applied to the amount of Usage Minute