Balance State Update Profile Properties

Balance state update profile properties are listed in Balance State Update Profile Properties.

Table 1. Balance State Update Profile Properties
Property Description
Name A descriptive name for the balance state update profile.
Description Information about the purpose of the balance state update profile.
External ID (Optional) Use this field to identify this item in MATRIXX pricing items. An External ID is saved to the pricing configuration file and loaded into the Pricing Database. Set the External ID value to any alphanumeric character that is meaningful to your implementation. An External ID can be used, for example, to relate offers in the MATRIXX system to products in an external pricing plan. It can be used, for example, by the Subscriber Management API to query and purchase product offers and bundle IDs.
Start Date The date on which the balance state update profile becomes valid in the pricing database and can be used during rating to extend a balance end date. The start date enables you to create multiple revisions of the same object at one time, each of which becomes active at a future date, so you do not need to roll out additional pricing plans for each change in your rating structure.

If the start date of the earliest revision of a balance state update profile is after the start period of the balance state update component that references it, it will not be examined during rating.

Balance Extension Type The time from which the balance end time is extended. One of:
  • From Existing End Time (default) — Set the end time of the balance instance from the current end time of the balance instance.
  • From Now — Set the end time of the balance to the current system time plus the requested time units.
    Note: When the balance state update profile is examined during rating, if the calculated end time specified here is less than the existing balance end time and the End Time Reduction Policy in the balance state update component is set to Allow Reduction Up To Now, the balance end time is adjusted to the new reduced end time. If the calculated end time specified here is less than the existing balance end time and the End Time Reduction Policy in the balance state update component is set to Deny, the end time does not change.
  • Optimal — Extends the end time of the balance instance from the current end time if the current end time is in the future. If the balance instance is expired, sets the end time of the balance to the current system time plus requested time units. This option optimizes the balance instance end time extension.
Extension Amount The number of time units to extend the balance end time. For example, to extend the end time two weeks, enter 2. The default value is 0.
Extension Units The time unit to use when extending the balance end time. One of:
  • minutes (default)
  • hours
  • days
  • weeks
  • months
  • years

For example, to extend the end time two days, enter 2 in Extension Amount and select Days in Extension Units.

End Time Adjustment Type Specifies whether to extend the balance end time to the end of the day or a specified end time on the expiration date. One of:
  • No Change (default) — Keeps the end time setting of the balance instance.
  • Extend to End of Day — Sets the end time to 11:59:59 PM on the day the balance instance expires.
  • Absolute Time — Sets the end time on the day the balance instance expires. When selected, enter the end time in the format hh:mm:ss. The default value is 00:00:00.