Offer Transition Conditions

Offer transition conditions determine when an automatic transition to a new status occurs. If any of the conditions evaluates to true, the transition to the new status occurs. For example, a purchased item (offer or bundle) that is canceled immediately transitions to the inactive status.

Many conditions can be defined for the same transition. If any of the conditions are true, the transition occurs. For example, a transition can include a condition for a purchased item being immediately canceled and for recurring failure occurring. If either of these conditions are true, the transition occurs.

The following sections describe the transition conditions.

MtxStatusConditionActivate

The MtxStatusConditionActivate condition is triggered by activating a pre-active offer. An offer can be activated in the following ways:
  • Automatic activation on usage.
  • Automatic activation by a specific time.
  • Activate the offer on a subscriber status transition.
  • Explicitly send a SubMan ModifyOffer request to update the status from pre_active to active.
  • Explicitly send a SubMan ActivateOffer request to activate the offer.
MtxStatusConditionActivate only inherits fields from the MtxStatusCondition MATRIXX Data Container (MDC), which has no configurable fields.

MtxStatusConditionAutoActivationTimeFailure

The MtxStatusConditionAutoActivationTimeFailure triggers when a pre-active purchased item cannot be activated at the specified auto activation time. The purchased item is transitioned from a pre-active state to an inactive state to stop further attempts to automatically activate it.
Note: This condition is only triggered when a time-based activation fails (that is, a purchased item with an auto activation time set). It is not triggered for a usage-based activation (that is, a product offer's Activate with Usage property is enabled) or when using a SubMan API request to activate a purchased item.

MtxStatusConditionAutoActivationTimeFailure only inherits fields from the MtxStatusCondition MDC, which has no configurable fields.

MtxStatusConditionCancel

The MtxStatusConditionCancel condition is triggered by canceling an offer. Offers are canceled through either a subscriber status transition or if a SubMan CancelOffer request is explicitly sent to cancel the offer immediately or at the end of the cycle. The MtxStatusConditionCancel condition is defined with the field in MtxStatusConditionCancel Options.
Table 1. MtxStatusConditionCancel Options
Field Description
Cancel Type Specifies whether the offer is canceled immediately or at the end of the cycle. The values are:
  • 1 — immediate (default)
  • 2 — end_of_cycle

MtxStatusConditionDebtPaid

The MtxStatusConditionDebtPaid triggers when all the debt balances in a purchased item are paid in full. MtxStatusConditionDebtPaid only inherits fields from the MtxStatusCondition MDC, which has no configurable fields.

MtxStatusConditionExternalPaymentLate

The MtxStatusConditionExternalPaymentLate triggers a status transition when the payment due date on any external payment request associated with the purchased item has exceeded a configured duration and it is still not yet paid. For example, if the configured duration is two days, then the payment is considered late if it has not been paid two days after the payment due date.

MtxStatusConditionExternalPaymentLate only inherits fields from the MtxStatusCondition MDC, which has no configurable fields.

In create_config.info, you can configure the number of days after the due date of an external payment request to consider the request overdue if it is not yet paid. The default is two days. For more information, see the discussion about defining the global system configuration in MATRIXX Configuration.

MtxStatusConditionPeriodExpiration

The MtxStatusConditionPeriodExpiration triggers when a period times out (for example, a timed-out grace period, recoverable period, or debt grace period). The MtxStatusConditionPeriodExpiration is defined with the fields in MtxStatusConditionPeriodExpiration Options.
Note:
Table 2. MtxStatusConditionPeriodExpiration Options
Field Description
Cycle End Indicates when end-of-cycle is reached.
Recoverable Period Set Indicates if the recoverable period duration is not zero in the grace period profile.

MtxStatusConditionPurchaseSuccess

The MtxStatusConditionPurchaseSuccess triggers when an offer purchase is successful. The MtxStatusConditionPurchaseSuccess is defined with the fields in MtxStatusConditionPurchaseSuccess Options.
Table 3. MtxStatusConditionPurchaseSuccess Options
Field Description
Debt Charge Indicates how the debt balances are impacted during the purchase operation. The values are:
  • 1 — partial_debt
  • 2 — total_debt

MtxStatusConditionRecurringFailure

The MtxStatusConditionRecurringFailure triggers when recurring processing fails for the maximum number of attempts. The MtxStatusConditionRecurringFailure is defined with the fields in MtxStatusConditionRecurringFailure Options.
Table 4. MtxStatusConditionRecurringFailure Options
Field Description
Has Grace Period Profile Indicates if a grace period profile is specified on the purchased item or on the aligned purchased item if Use Master Purchased Item Grace Period Profile is true.
Grace Period Set Indicates if the grace period duration is not zero in the grace period profile.
Use Master Purchased Item Grace Period Profile Indicates whether a purchased item cycle that is aligned to another purchased item cycle uses the grace period profile of the master purchased item.
Recoverable Period Set Indicates if the recoverable period duration is not zero in the grace period profile.

MtxStatusConditionRecurringSuccess

The MtxStatusConditionRecurringSuccess triggers when recurring processing is successful.
Note: For a class_active to class_active status transition using this status condition, the Debt Charge or External Payment Status options must be specified.

The MtxStatusConditionRecurringSuccess is defined with the fields in MtxStatusConditionRecurringSuccess Options.

Table 5. MtxStatusConditionRecurringSuccess Options
Field Description
Debt Charge Indicates how the debt balances are impacted during recurring processing. The values are:
  • 1 — partial_debt
  • 2 — total_debt
External Payment Status Indicates the external payment status. This value is used to configure status transitions based on the payment status of the External Payment Request. The values are:
  • 1 — due
  • 2 — paid

MtxStatusConditionResume

The MtxStatusConditionResume condition triggers when a suspended purchased item is resumed by a subscriber status transition. When the purchased item is resumed, recurring processing is attempted. By default, if recurring processing fails, the purchased item remains in the suspended state. If the Recurring Failure on Resume Allowed cycle data configuration is selected for the purchased item, then if recurring processing fails, the following occurs depending on the status of the purchased item:
Note: The following applies when the purchased item is not suspended in pause mode nor part of a purchase package.
  • When resuming a purchased item in a suspended or suspended_new_cycle status, transition it to either a grace state, recoverable state, or inactive state based on the grace period profile and transitions configured for the MtxStatusConditionRecurringFailure condition.
  • When resuming a purchased item in suspended_grace status, transition it back to a grace state.
  • When resuming a purchased item in suspended_recoverable status, transition it back to a recoverable state.
Only one purchased item status change notification indicates the final offer status.

When a suspended purchased item reaches the end of the cycle, transition the purchased item to an inactive state or to a class_suspended_new_cycle state using the MtxStatusConditionPeriodExpiration status condition with the Cycle End option. If the purchased item transitions to a class_suspended_new_cycle state at the end of its cycle, a new cycle definition is established when the purchase item is resumed and its start time is the resume time. The new cycle definition is returned in a query response.

For more information about the Recurring Failure on Resume Allowed option, see the discussion about applying cycle data to bundles and offers. For more information about offer life cycle profile status classes, see the discussion about the offer life cycle status class diagram in MATRIXX Subscriber Management API.

MtxStatusConditionResume only inherits fields from the MtxStatusCondition MDC, which has no configurable fields.

MtxStatusConditionSuspend

The MtxStatusConditionSuspend condition is triggered when an offer is suspended by a subscriber status transition. MtxStatusConditionSuspend only inherits fields from the MtxStatusCondition MDC, which has no configurable fields.