Offer Life Cycle Status Codes

Offer life cycle status codes are linked to offer life cycle status definitions in an offer life cycle.

An offer life cycle status definition defines the behavior allowed for each status and consists of the following:
  • An offer life cycle status code.
  • An offer status class.
  • Status policies.
  • Status transitions (conditions and actions).

Status definition behavior is determined by its associated offer status class. Each class has specific policies enabled by default.

Offer Status Policies

Offer status policies define the behavior of an offer life cycle and are, by default, enabled through specific offer status classes. The policies supported by the offer status classes are:

  • MtxStatusPolicyOfferRecurring — Defines whether recurring processing is enabled.
  • MtxStatusPolicyOfferRating — Defines whether an offer can be used for rating.
  • MtxStatusPolicyOfferPolicy — Defines whether an offer can be used for policy.
  • MtxStatusPolicyCancel — Defines whether an offer can be canceled.
  • MtxStatusPolicySuspend — Defines whether an offer can be suspended. When enabled, the policy values are:
    • Offer Defined (default)
    • Always

Offer Status Transitions and Conditions

Offer status transitions can be defined for the following offer status conditions: Activate, Cancel, Suspend, Resume, RecurringFailure, RecurringSuccess, and PeriodExpiration. If the status policy indicates that the business action is allowed and a transition is defined, the purchased item will transition to the target status specified in the transition.

If the status policy indicates that the business action is allowed but no transition condition is defined on the status condition for the business action, the purchased item will transition to the default status in the target status class. For the CancelOffer business action, the purchased item will transition to the default status in the class_inactive status class. For the SuspendOffer business action, the purchased item will transition to the default status in the class_suspended status class.

If the status policy indicates that the business action is not allowed, a SubMan call returns an error message that it is not allowed, and an implicit action (for example, cancel offer on subscriber status transition) logs an INFO message and there is no status transition.

For more information, see the discussion about offer transition conditions.

Offer Status Classes

The behavior associated with an offer life cycle status code is determined by its offer status class. An offer status class cannot be customized. Offer Status Classes lists the offer status classes and the policies that are enabled for each class.
Table 1. Offer Status Classes
Offer Status Class Description Policies Enabled
class_active The purchased item has a status of active. All behavior is supported.
  • MtxStatusPolicyOfferRecurring
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_in_cancellation The purchased item has a status of in_cancellation. The start and end times of the item cannot be modified. Recurring processing is disabled.
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_inactive The purchased item has a status of inactive. Purchased items in this status class:
  • Are in a terminal status where the purchased item cannot be transitioned to another status class.
  • Cannot have their start and end times modified.
  • Recurring processing is disabled.
  • Are purged after the configured delayed period.
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_suspended The purchased item has a status of suspended. Recurring processing is disabled.
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_pre_active The purchased item has a status of pre-active. Purchased items in this status class:
  • Do not have a cycle established yet.
  • Cannot be used for rating or policy.
  • Recurring processing is disabled.
  • Remain in this class when it is suspended and then resumed.

Purchased items in any other status class cannot be transitioned to this status class.
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_grace The purchased item has a status of grace. If a grace period is specified in the grace period profile for a purchased item, when recurring processing fails for that item, it goes into the grace period and its status changes to grace.
  • MtxStatusPolicyOfferRecurring
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_recoverable The purchased item has a status of recoverable. If a recoverable period is specified in the grace period profile for a purchased item, when recurring processing does not succeed during the grace period, the item goes into the recoverable period and its status changes to recoverable.
  • MtxStatusPolicyOfferRecurring
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend
class_suspended_new_cycle The purchased item is in a suspended state and recurring processing is disabled. When the purchased item is resumed, a new cycle definition is established with the resume time as the cycle start time.
  • MtxStatusPolicyOfferRating
  • MtxStatusPolicyOfferPolicy
  • MtxStatusPolicyCancel
  • MtxStatusPolicySuspend

Default Status for the Offer Status Classes

An offer life cycle status code consists of a status value, a description, and the associated offer status class. The offer status code inherits the behavior as defined in the offer status class and can be customized with additional behavior.

Default Status for the Offer Status Classes lists the offer life cycle status codes provided by default and their associated class. Each class can only have one default code associated with it.
Table 2. Default Status for the Offer Status Classes
Status Offer Life Cycle Status Code Offer Status Class Default
1 active class_active true
2 in_cancellation class_in_cancellation true
3 inactive class_inactive true
4 suspended class_suspended true
5 pre-active class_pre_active true
6 grace class_grace true
7 recoverable class_recoverable true
8 suspended_grace class_suspended false
9 suspended_recoverable class_suspended false
10 suspended_pre_active class_pre_active false