Cycle Data Properties

Table 1. Cycle Data Properties
Property	Descriptions
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. The choices are: 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 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 set the ordering among purchased item cycles that have a period beginning at the same time. The purchase order is used if two purchased items have cycles beginning at the same time and they have the same priority.
Continue After Failure	Controls what happens when recurring processing fails for a purchased item cycle. If set to true, recurring processing continues for other purchased items. If set to false, no other purchased item cycles are processed. Note: This setting does not block recurring processing for balance or billing cycles if recurring processing fails for a purchased item cycle.
Override Allowed	Allows any client to override the product cycle data at purchase time.
Enable Last Period Proration	Allows recurring processing to prorate any charges that expire during the processing period.
Recurring Failure on Purchase Allowed	Allow recurring processing to succeed during purchase if it would otherwise fail due to insufficient credit.
Recurring Failure Override on Purchase Allowed	Allow 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	(Optional) 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.
Recurring Advance Notification Profile	(Optional) 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. Automatic recurring recharges are recharges triggered prior to the start of the billing cycle at an interval configured by the carrier.
Late Charge Notification Profile	(Optional) 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.
Cycle Holding Balance	Defined only if the product offer 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, an Offer 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.

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. The choices are:

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 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 set the ordering among purchased item cycles that have a period beginning at the same time. The purchase order is used if two purchased items have cycles beginning at the same time and they have the same priority.

Continue After Failure

Controls what happens when recurring processing fails for a purchased item cycle. If set to true, recurring processing continues for other purchased items. If set to false, no other purchased item cycles are processed.

Note: This setting does not block recurring processing for balance or billing cycles if recurring processing fails for a purchased item cycle.

Override Allowed

Allows any client to override the product cycle data at purchase time.

Enable Last Period Proration

Allows recurring processing to prorate any charges that expire during the processing period.

Recurring Failure on Purchase Allowed

Allow recurring processing to succeed during purchase if it would otherwise fail due to insufficient credit.

Recurring Failure Override on Purchase Allowed

Allow 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

(Optional) 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.

Recurring Advance Notification Profile

(Optional) 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.

Automatic recurring recharges are recharges triggered prior to the start of the billing cycle at an interval configured by the carrier.

Late Charge Notification Profile

(Optional) 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.

Cycle Holding Balance

Defined only if the product offer 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, an Offer 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.