Sponsorship Rule Properties

Create sponsorship rules to add to sponsorship profiles. The order of rules in the rule array is the order the rules take precedence. Sponsorship rules are reusable.

Sponsorship Rules Properties lists the properties for sponsorship rules.

Table 1. Sponsorship Rules Properties
Option Description
ID A unique ID that identifies the sponsorship rule.
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.
Name Name of the sponsorship rule.
Description Description of the sponsorship rule.
Charge Type The type of charge applied to the sponsor: Original or Remaining.
  • Original — This is the default; it bases the percentage off the original charge.
  • Remaining — This takes the percentage off whatever charge is remaining.
BalanceClassId Class ID of the sponsoring balance.
Note: The balance precision of both the sponsoring and sponsored balances must match.
BalanceTemplateId Template ID of the sponsoring balance.
Percentage Percentage of the quantity that can be sponsored by the sponsoring balance. This value can be a non-decimal, like 90, or a decimal that is converted to a percentage, like 0.9. The percentage cannot be more than 100 percent. To implement a value like 0.5%, for example, use the decimal 0.005.
Override Container Name of the custom MDC container used to override the defined percentage. For more information about sponsorship rule overrides, see the discussion about sponsorship overrides.
Override Field Name of the custom MDC field used to override the defined percentage.