Bundle Properties

Bundle properties can apply to the base bundle, the bundle version, or the bundle revision.

Note: Bundle properties (such as notification, start and end types, expiration policy, and so forth) supersede the corresponding property in the individual product offers.

Bundle Properties describes the bundle properties.

Table 1. Bundle Properties
Property	Description
ID	The internal bundle ID. Set automatically and cannot be changed.
Name	A descriptive name for the bundle.
Description	(Optional) Description used to identify the bundle.
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.

Bundle Version Properties describes the bundle version properties.

Table 2. Bundle Version Properties
Property	Description
Version ID	The internal bundle version identifier. Set automatically and cannot be changed. Different revisions of a bundle version can reference different versions of a product offer or other bundle.
Version Name	The name of the bundle version.
Version Description	(Optional) Description used to identify the bundle version.
External ID	The bundle external ID set when you create the bundle. See External ID above.
Version External ID	An external ID that identifies a specific bundle version. See External ID above. The version external ID is also stored in the pricing database.
Purchase Start Date	(Optional) Start date when this bundle version is available for subscribers to purchase. All revisions to this version are made available on this date.
Purchase End Date	(Optional) Date after which the bundle version can no longer be purchased.

Bundle Revision Properties describes the bundle revision properties.

Table 3. Bundle Revision Properties
Property	Description
General Properties
Payment Method	Specifies the bundle purchase payment method. Choose from: Pay On Account — Use the currency balance. Payment is not immediate. Pay Now — Always use Pay Now. A payment method must be defined before using Pay Now. Pay Now or Pay On Account — Use Pay Now if the subscription or group is configured to use Pay Now. Otherwise, use Pay On Account. Note: If no selection is made, Pay On Account is used by default.
Revision Start Date	Determines when the revision becomes valid for rating. The start date for a revision must be after the start time of the previous revision. If the offer start time is not set, it becomes available immediately at purchase time. The version start time is applicable for every revision of that version.
Expiration Policy	Sets whether bundled product offers should be canceled when the bundle expires. Note: Bundle settings override the Expiration Policy of individual offers purchased as part of the bundle. None — (Default) No cancelation pricing or proration pricing is applied to bundled offers. Offers are invalid during rating. Cancel — Triggers any cancelation pricing and proration processing for recurring charges associated with bundled offers. This makes the offers invalid during rating. Important: A bundle cannot have an expiration policy of Cancel if it references an offer that contains a cancelation charge; bundled offers that include a cancelation charge are not canceled.
Expiration Notification Profile	The notification profile that determines the notification behavior for bundle expirations.
Notifies on Purchase	When selected, a notification is sent to the contact person associated with the subscriber or group, informing them that a bundle has been purchased.
Notifies On Cancel	When selected, a notification is sent to the contact person associated with the subscriber or group canceling the bundle, informing them that a bundle was canceled.
Notifies On Suspend	When selected, a notification is sent to the contact person associated with the subscriber or group suspending the bundle, informing them that a bundle was suspended.
Notifies On Resume	When selected, a notification is sent to the contact person associated with the subscriber or group resuming the bundle, informing them that a bundle was resumed.
Offer Life Cycle Profile	Specifies the life cycle profile that determines the status definitions and transitions for this bundle. If none is selected, the default life cycle profile is used.
Start/End Properties
Start	Specifies when the bundle is available for rating operations (validity period). Purchase Time — The bundle becomes valid for rating immediately when it is purchased. This is the default if a different Start option is not specified. In such cases, all purchase operations occur immediately, such as associating the purchased bundle with the subscriber or group, adding necessary balances to the wallet, applying pricing, and sending a purchase notification, if configured. Specified at Purchase — Allows service representatives to specify a start time for the bundle when they purchase it for a subscriber or group. Important: If the start time is not set, the offer is valid from the time of purchase. If set, the start time must be before or the same as the purchase time. Specifying a later start time will generate an error during rating. Absolute — The bundle becomes valid on the specified date and time. You must specify the month, day, and year and can optionally specify a time of day. If a time of day is not specified, the bundle becomes valid for rating at 12:00:00 AM on the date specified. Note: If the absolute date is in the future, any attempted purchase of that offer will fail until the offer becomes valid.
End	Specifies when the bundle validity period ends. None — The bundle end date is set to the maximum end date, which is effectively no end date. If set to None, the end date can be set explicitly in the bundle purchase call. Purchase Relative — The bundle becomes invalid after an amount of time relative to the purchase date. If you select this option, in Ends in, specify a positive integer indicating the offset from the purchase date and select one of the following offset units: Minutes Hours Days Weeks Months Years Billing Cycle Inclusive — The bundle end time is calculated as N cycles after the start of this cycle; the end time of the current billing cycle is included as the end of one elapsed billing cycle. Billing Cycle Exclusive — The bundle end time is calculated as N cycles after the end of this cycle; the current billing cycle is not included in the specified number of elapsed billing cycles. Billing Cycle Inclusive and Billing Cycle Exclusive set the end time of the purchased bundle to the end time of a specified number of elapsed billing cycles. The bill cycle length is fixed at purchased time and does not change if a billing cycle is modified. Start Relative — The bundle becomes invalid after an amount of time relative to the start date. If you select this option, in Ends in, specify a positive integer indicating the offset from the start date and select one of the following offset units: Minutes Hours Days Weeks Months Years Billing Cycle Inclusive — The bundle end time is calculated as N cycles after the start of this cycle; the end time of the current billing cycle is included as the end of one elapsed billing cycle. Billing Cycle Exclusive — The bundle end time is calculated as N cycles after the end of this cycle; the current billing cycle is not included in the specified number of elapsed billing cycles. Billing Cycle Inclusive and Billing Cycle Exclusive set the end time of the purchased bundle to the end time of a specified number of elapsed billing cycles. The bill cycle length is fixed at purchased time and does not change if a billing cycle is modified. Absolute — The bundle becomes invalid on the specific date and specific time you set in End Date/Time. Absolute and Purchase Relative — The bundle becomes invalid on either the absolute date you set in End Date/Time or the purchase-relative date you set in Ends in, depending on which one occurs first. Absolute and Start Relative — The bundle becomes invalid on either the absolute date you set in End Date/Time or the start-relative date you set in Ends in, depending on which one occurs first. Cycle Count — The bundle ends in the number of cycles specified in Ends in. To select Cycle Count, you must first select a Period Type on the Cycle Data tab.
Offers Properties
Offers	Displays the product offers in the bundle.
Custom Fields Properties
Custom Bundle Fields	Displays the custom fields you can use to manipulate bundle purchases using custom MDC fields. You select a bundle extension from list, and custom fields appear for that extension.
Template Field Properties
Catalog Item Template	A menu of templates. The templates supply a superset of the fields to use for a catalog item. Check fields to use in the catalog item by checking the Enabled box. Only enabled template fields display when creating a catalog item. For more information about catalog item template fields, see the discussion about creating or changing a catalog item.
Enabled	Check a template field box to use that field in the catalog item.
Name	The name of the field.
Type	The data type of the field.
Value	A mandatory value for the field. It must match the data Type.
Metadata	Use to specify individual metadata values (for each template field) that the bundle template uses in the bundle catalog item. The metadata items must match the template field data type. None — Specifies no metadata. Range — Specifies a numerical data range between a Min and Max values, which you specify. Enumeration — Specifies a set of values that you enter individually in the New Value field and click Add to add.
Cycle Data Properties
Period Type	The increment to use for the cycle offset. Can be one of: empty (no value) Minutes Hours Days Weeks Months Years Note: An offer or bundle with a cycle data Period Type of Hours or Minutes is incompatible with a grace period profile that specifies a recoverable renew time. This combination fails pricing validation.
Period Interval	A numeric value for the number of period increments to use for the cycle offset.
Cycle Offset Type	The type of cycle offset. Determines the start of the first interval. Note: You must set the Cycle Offset Type to avoid a validation error. Can be one of: Billing Cycle — The cycle is aligned to the billing cycle. Purchase Time — The cycle is initialized by the purchase time. Fixed Offset — Supported for the year, month, and week Period Types. Starts on the specified day relative to the Period Type. The Cycle Offset field sets the number of days to offset. For example, a Period Type of Months, using Fixed Offset, and a Cycle Offset of 2, starts the cycle on the second day of the month before the purchase date. The cycle continues monthly on the second day of each month. Purchase Date — The cycle start date is the purchase date. When you specify Purchase Date, you must set the Cycle Start Type and the Cycle Start Time (if the Cycle Start Type is `absolute`).
Cycle Offset	Use with the Fixed Offset cycle offset type. A numeric value that sets the number of cycle increments to use in the offset.
Cycle Start Type	The type of cycle offset. The choices are: Absolute — A specific time of day to start. The default is the first second of the day. You can optionally enter a specific time of day for the cycle to start. Purchase Time — Establishes the time of day component for the purchased item cycle. If you use the Fixed Offset option to Cycle Offset Type, this option establishes the cycle time of day at the time the product is purchased.
Grace Period Profile	Use to select a grace period profile. Grace period profiles specify options for allowing a subscriber to re-establish cycle processing after that processing has failed.
Priority	A numeric priority value used to rank this cycle against priority values of the cycles of other products purchased at the same time.
Continue After Failure	Gives you the option to continue recurring processing after that processing has failed due to a lack of credit.
Override Allowed	Allows any client to override the product cycle data at purchase time.
Enable Last Period Proration	Allows charges and grants for product offers and bundles with a purchased item cycle to be prorated if the purchased item expires within the upcoming cycle.
Recurring Failure on Purchase Allowed	Allows recurring processing to succeed during purchase if it would otherwise fail due to insufficient credit.
Recurring Failure on Purchase Override Allowed	Allows the Recurring Failure on Purchase Allowed specified here to be overridden during purchase.
Recurring Failure on Resume Allowed	Allow resume to succeed even when there are not enough funds to pay for the recurring charge.
Recurring Failure Notification Profile	Controls when notifications are generated during or after recurring processing failure. If a profile is not selected, MATRIXX Engine does not generate notifications for this notification type. A notification profile can be configured to send notifications at different times (for example, immediately and an hour after the initial recurring failure for the period). For more information about recurring processing failure, see MATRIXX Pricing and Rating.
Recurring Advance Notification Profile	Controls when advance notifications are generated for upcoming recurring processing (notifications that are generated before the start of a recurring cycle period). If a profile is not selected, MATRIXX Engine does not generate notifications for this notification type.
Recurring Recharge Notification Profile	Controls when advance notifications are generated for upcoming automatic recurring recharges. If a profile is not selected, MATRIXX Engine does not generate notifications for this notification type.
Late Charge Notification Profile	Controls when notifications are generated before, during, or after late charges are assessed. If a profile is not selected, MATRIXX Engine does not generate notifications for this notification type. A notification profile can be configured to send notifications at different times (for example, immediately and an hour after the initial recurring failure for the period). For more information about recurring processing failure, see MATRIXX Pricing and Rating.
Cycle Holding Balance	Defined only if the bundle is configured to have its own recurring cycle (purchased item cycle). The actual-currency balance template the Charging Application uses for creating the cycle holding balance, a Bundle specific balance that is used to accumulate funds during recurring processing. The list shows all actual-currency balance templates defined for the current domain. The balance template selected for a cycle holding balance must have the following characteristics: Simple balance Non-aggregated Prepaid (credit limit = 0) For information about when currency is held in the cycle holding balance or when charges are performed from it, see the discussion about cycle holding balances in MATRIXX Pricing and Rating.
Debt Balances Properties
ID	The balance template identifier.
Name	The name of the selected balance template.
Balance Class	Identifies the currency balance class that defines how balance template properties are displayed.
Balance Name	Identifies the actual currency balance.
Debt Type	Debt balance type. The bundle can specify a debt type not in the offers. Select from: Fee Purchase Recurring
Write Off Policy	The write-off policy for the selected debt balance type. Select from: None (default) Cycle Specific Time Expired For more information about how debt balance is written-off based on the configured write-off policy, see the discussion about debt balance and recurring write-off policy in MATRIXX Pricing and Rating. Note: Purchase debt can be configured with a write-off policy of None, Specific Time, or Expired. Recurring debt can be configured with a write-off policy of None, Cycle, or Expired. Fee debt can be configured with a write-off policy of None, Cycle, or Expired.
Write Off Interval	If the Write Off Policy is set to Specific Time, enter the write off interval value.
Write Off Units	If the Write Off Policy is set to Specific Time, select the write off policy unit: Minutes (default) Hours Days Weeks Months
Parameters Properties
Name	The name of the parameter set from the parameter definition.
Type	The data type of the parameter set from the parameter definition.
Description	The description of the parameter set from the parameter definition.
Default Value	The default value to use for the parameter. Users can override the default value with the actual value to use for the parameter at purchase time.
Bundle Level Pricing
Bundle Price Components	Configure single bundle pricing and define percentage (proportional) distribution for the bundle charge for each product offer. Charge and discount pricing components for purchase, activation, cancelation, and recurring processing for purchased item cycles are referenced from the bundle (not from the product offers), and are for the entire bundle (not for specific product offers). Note: Add only one application-price type combination. Once a pair is added all others are filtered out. For price components with the Application type Recurring, only Cycle with Purchased Item are available for selection. There can be only one charge, and only one discount component. If a product offer with charge or discount components for these applications is added, the components must be redefined in the bundle for these applications. For more information about bundle level pricing, see the discussion about proportional charge bundles in MATRIXX Pricing and Rating.
Distribution Method	Select the distribution method (proportional) for the bundle charge for each product offer. The bundle price is distributed to the constituent offers. Select from: Distribute total — Distribute total charge, including taxes and fees. Distribute base charge and taxes — Distribute base charge and taxes without fees. Does not include fees. Distribute base charge only — Distributes base charge. Does not include fees or taxes. For more information, see the discussion about proportional charge bundles in MATRIXX Pricing and Rating.
Offer Charge Distribution	The revenue distribution method. Note: The Offer Charge Distribution table displays the qualified offers for purchase, activation, recurring processing for purchased item cycles, and cancelation offers added to the Offers tab. ID — Qualified offer identifier. Name — Qualified offer name. Charge Percent (Total: %) — Charge distribution percentage value. Decimal value between 0 and 100. Note: The sum of all distribution field values must be 100%. If you delete an offer from the Offers tab, and the sum of the Charge Percent fields in the Offer Charge Distribution table is not 100%, you can save your changes but an error displays and the Bundle Level Pricing tab is highlighted.

For more information about purchase start and end dates, see the discussion about product offer validity periods in MATRIXX Pricing and Rating.