Service Contracts

Configure a service contract in My MATRIXX by defining the terms and charges for a service, for example, voice or data. After a service contract is configured, you define the pricing components required to set up the contract in the service contract product offer. A service contract offer can be owned by a subscriber, group, or device.

Service Contract Revision

A service contract can be revisioned, but not versioned. A contract revision is a copy of the service contract with changes to one or more attributes.

Service Contract Revisionable Properties describes the revisionable attributes available in a service contract.

Table 1. Service Contract Revisionable Properties
Property Description Type
Name (Required) A descriptive name for the contract, which displays in the Contract Table list of contracts from which to select. The name is also saved to the event detail record (EDR) generated by MATRIXX Engine. string
Description A description used to identify the contract. string
External ID An optional field that you can use to identify this item in MATRIXX pricing items. External IDs are saved to the pricing configuration file and loaded into the pricing database. The value of an External ID can be set to any alphanumeric character that is meaningful to your implementation. string
Start Date Activation date of the new revision of the contract. datetime
Is Open Contract Specifies whether the contract has an open term (no end date). Disabled when Contract Period and Contract Interval are set. Boolean
Contract Period Required when Is Open Contract is deselected. Specifies the contract term period. Select from:
  • week
  • month
  • year
Disabled when Is Open Contract is selected.		 unsigned int32 (enum)
Contract Interval Specifies the number of contract periods in the contract. For example, if the interval is 12 and the Contract Period is month, then it is a 12 month contract.

Disabled when Is Open Contract is selected.

 unsigned int32
Period Type Required when Contract Interval is selected. Specifies the contract period type. Select from:
  • Minutes
  • Hours
  • Days
  • Weeks
  • Months
  • Years
 unsigned int32 (enum)
Period Interval Required when Period Type is set. Specifies the number of periods for the period type to define the length of the cycle period. unsigned int32
Commitment Period Specifies the type of commitment period. Select from:
  • week
  • month
  • year
 unsigned int32 (enum)
Commitment Period Interval Required when Commitment Period is set. Specifies the number of intervals for the specified commitment period.

Enter the Commitment Period Interval for the selected period.

 Boolean
Late Charge Basis Specifies the late charge basis. Select from:
  • Fixed
  • Percent of cycle recurring charges
 unsigned int32 (enum)
Late Charge Required when Late Charge Basis is set. Specifies the late charge.
  • When set to Fixed, enter the late charge amount.
  • When set to Percent of cycle recurring charges, enter the percentage amount.
 decimal
Late Charge Grace Period Type Specifies the late charge grace period type. Select from:
  • hour
  • day
  • week
  • month
  • immediate
  • minute
 unsigned int32 (enum)
Late Charge Grace Period Coefficient Time coefficient for late charge grace period, used with late charge grace period type. For example, 2 days, 3 hours. Late Charge Grace Period Coefficient is required when Late Charge Grace Period Type is set, unless Late Charge Grace Period Type is set to Immediate or is empty, in which case Late Charge Grace Period Coefficient is disabled (not required). unsigned int32
Termination Charge Basis Specifies the termination charge basis. Select from:
  • Fixed — When selected, enter the fixed amount in Termination Charge Fixed.
  • Percent of remaining cycle recurring charges — When selected, enter the percentage in Termination Charge Percent.
  • Fixed plus percent of remaining cycle recurring charges — When selected, enter the corresponding values in Termination Charge Fixed and Termination Charge Percent.
Disabled when an early termination charge (ETC) schedule is selected in ETC Schedule.		 unsigned int32 (enum)
Termination Charge Fixed Fixed amount of termination charge. Enter the fixed amount if Termination Charge Basis is set to Fixed or Fixed plus percent of remaining cycle recurring charges. decimal
Termination Charge Percent Percent amount of termination charge. Enter the percentage if Termination Charge Basis is set to Percent of remaining cycle recurring charges or Fixed plus percent of remaining cycle recurring charges. decimal
Balance Class The balance class ID used to impact all payments. unsigned int32
Balance The currency balance template pricing ID used to create the contract debt balance instance based on the selected Balance Class. The balance is a simple, post-paid, actual currency balance with an unlimited credit limit. unsigned int32
ETC Schedule ID Service contract ETC schedule Id. Disabled if the Termination Charge Basis field is selected. unsigned int 64
Payment Schedule ID Specifies the payment schedule Id. unsigned int 64