Balance State Update Component Properties

Balance state update components have references to one or more balance state update tables in addition to the properties listed in Balance State Update Component Properties. Each component table contains a decision table comprised of normalizers and their related balance state update profile.

Table 1. Balance State Update Component Properties
Property Description
Name A descriptive name for the balance state update component.
Description Information about the purpose of the balance state update component.
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 component becomes valid in the pricing database and can be used during rating to determine which balance state update profile to choose. 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 component is after the valid period of the product offer that references it, the balance state update component will not be examined during rating.
Note: If you are creating a new revision of this object, the start date/time must be greater than the start date/time of the previous revision and less than the start date/time of the next revision. If you are making a copy of this object, the start date/time is not copied. The new object is the first revision, so it has the default start date of 2000-01-01.
Application Specifies the balance state update component application type.

The options are:

  • purchase (default) — The balance state update component applies to a product offer purchase.
  • auto_renew — The balance state update component applies to an auto-renew operation. For information about auto-renew, see the discussion about price components in MATRIXX Pricing and Rating.
  • balance_threshold — The balance state update component applies to balance-threshold based pricing. For information about balance-threshold based pricing, see the discussion about price components in MATRIXX Pricing and Rating.
  • purchased_item_activation — The balance state update component is applied when a product offer or bundle purchased in a pre-active state is activated.
    Important: Product offers and bundles with activation components must be purchased in a pre-active state or the purchase will fail.
  • resume — The balance state update component is applied when a product offer or bundle, purchased in a pre-active state, is resumed.
    Note: When an offer is resumed, the proration types are used to calculate the amount of recurring charge and grant. Upon offer resumption, a new cycle with a new interval ID is established per the existing cycle definition.
  • suspend — The balance state update component is applied when a product offer or bundle, purchased in a pre-active state, is suspended.
    Note: When an offer is suspended, no refund or forfeiture is issued at the time of offer suspension, and no recurring charge or grant at the time of offer resumption.
Balance (balance_threshold application only) The balance whose threshold, when crossed during rating, triggers the balance state update component to be applied for balance-threshold based pricing.
Threshold (balance_threshold application only) Optional threshold (of the specified balance) that when crossed, triggers the balance state update component to be applied for balance-threshold based pricing.

When this threshold for the specified balance is crossed during rating, this triggers the balance state update component to impact (extend the validity of) the balance that you specified on the table(s) in the component (specified on the Balance State Update Tables).

Is Instance Specific (balance_threshold application only) When selected, indicates that the balance-threshold based pricing configuration for the balance state update component applies to only balance instances created by the containing offer.
When de-selected, indicates that the balance-threshold based pricing configuration for the balance state update component applies to all balance instances in the balance template.
Note: When selected and the triggering balance instance is of the same balance template as specified in any of the applied offer required balances, but this balance instance was not created by this offer during purchase, then this balance_threshold balance_state component is skipped. Otherwise, the balance_threshold_balance_state component is triggered.
Tier An optional field that specifies the tier to which the balance state update component is applied. If the tier is specified, the required tier balance instance at the specified tier is always selected for the balance class or template if one is associated with that offer. If a tier is not specified in a balance state update component, the group at the specified tier is selected and its local wallet is evaluated for possible balance class or template matches. For more information about required tier balances, see the discussion about product offer required tier balances in MATRIXX Pricing and Rating.
Limit Balance Extension to The amount to limit the amount of extension that can be applied to a balance. The value set here limits the end time of a balance instance to a maximum duration; it is a limit (cap) for balance instance end time, relative to the time the component is evaluated (for example as a purchase or auto-renewal).
Extension Limit Units The unit value of the balance extension to be limited. Choose from:
  • empty
  • minutes
  • hours
  • days
  • weeks
  • months
  • years
Extension Limit Policy The policy to allow or deny the balance extension. The policy determines, when the limit is exceeded, whether to allow the operation to proceed with the limited extension quantity or to fail the extension. Choose from:
  • empty
  • Allow Limited Extension
  • Deny Limited Extension
Reduction Policy The policy to allow or deny end time reduction from now (not in the past). The policy determines whether to allow the current balance to be adjusted even if a date earlier than the current balance end time is calculated. Choose from:
  • empty
  • Allow Reduction Up To Now
  • Deny Reduction
Balance State Update Component Table Properties describes the balance state update component table properties.
Table 2. Balance State Update Component Table Properties
Property Description
Name A descriptive name for the balance state update table.
Description Information about the purpose of the balance state update table.
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.
Default Result A default profile or the SKIP value to use when the normalization values present during rating do not match any of the results defined in the balance state update table.
Balance The balance that will have its end time extended.
Decision Table A table that contains one or more normalizers that the balance state update table uses to associate with results. Each result can be a profile to select or a SKIP value.