Suspending and Resuming Product Offers

Use the MtxRequestSubscriberSuspendOffer, MtxRequestSubscriberResumeOffer, MtxRequestGroupSuspendOffer, MtxRequestGroupResumeOffer, MtxRequestDeviceSuspendOffer, and MtxRequestDeviceResumeOffer APIs to suspend or resume an offer for a subscriber, group, or device if it is permitted by the current offer status class.

If the status policy indicates that suspend or resume is allowed, and there is a transition defined for the suspend or resume status condition, the offer will transition to the target status defined in the transition. Additionally, you can configure a notification to be sent upon suspension, resumption, or when the suspend or resume fails.

When an offer is suspended, the proration types defined in the offer are used to calculate the amount of a cancel refund and a cancel forfeiture. When the offer resumes, the proration types defined in the offer are used to calculate the amount of the recurring charge and grant and a new cycle with a new interval ID is created according to the existing cycle definition.

Note: You can override the proration types defined in the offer using the input parameters of the SuspendOffer or ResumeOffer SubMan APIs.

For more information about proration, see the discussion about pricing proration in MATRIXX Pricing and Rating.

For more information about suspending an offer, see the discussions about MtxRequestDeviceSuspendOffer, MtxRequestGroupSuspendOffer, and MtxRequestSubscriberSuspendOffer in MATRIXX Subscriber Management API. For more information about resuming an offer, see the discussions about MtxRequestDeviceResumeOffer, MtxRequestGroupResumeOffer, and MtxRequestSubscriberResumeOffer in MATRIXX Subscriber Management API.

Suspend in Pause Mode

You can suspend a subscription, global, or service contract product offer for a subscriber, group, or device in Pause mode so that the refunds, forfeitures, charges, and grants do not occur.

In My MATRIXX, select Pause on Suspension in the MtxStatusActionSuspendAllOffer status transition action to suspend an offer and put it in Pause mode. Or, use the SuspendOffer API IsPauseMode parameter to suspend an offer in the Pause mode. When in Pause mode, no refunds or forfeitures are issued when the offer is suspended, and no recurring charges or grants are issued at the time of offer resumption. When an offer exits Pause mode, the end time of the current purchased item cycle (if not aligned to bill cycle) and the end time of the offer are extended by the length of the offer's suspension:

Purchased Item Cycles (Not aligned to Bill Cycles) — When the offer resumes, the suspended cycle length is extended and the interval ID remains the same. The remaining cycle duration is equal to the remaining cycle duration when the offer was suspended. The subsequent purchased item cycles start on the new offset. For example:
- A purchased offer CycleEndTime is June 20, 2021.
- The offer is suspended on June 10, 2021 in Pause mode. The remaining cycle duration is 10 days.
- When the offer is resumed on July 25, 2021, the CycleEndTime is extended to August 4, 2021 so that the remaining cycle duration is 10 days.
The validities of the remaining private asset balances (from recurring grants) and any resume balance state update pricing components defined in the product offer are adjusted; non-private asset balances are not automatically adjusted. Private asset balances are not forfeited while the offer is suspended in Pause mode.
Purchased Item Cycles (Aligned to Bill Cycles) — The CycleEndTime is not changed after offer resumption.

The end times of non-private balances are not implicitly modified. They can be explicitly modified by using suspend or resume balance state update pricing components.

Specify the Pause mode using the suspend and resume APIs or when defining the MtxStatusActionSuspendAllOffer status transition action. The MtxStatusActionSuspendAllOffer field, IsPauseMode, indicates if the offer should be suspended in Pause mode. For information about status transition actions, see the discussion about status transition actions in MATRIXX Subscriber Management API.

The MtxSuspendEvent Event Detail Record (EDR) indicates if the offer is suspended in Pause mode. The MtxResumeEvent EDR indicates the resumed interval ID and the new interval end time (for purchased item cycles only). The adjusted validity of the private balances is recorded in the MtxBalanceStatusUpdate array within the MtxResumeEvent EDR.

Consider the following scenarios:

A subscriber in Active status is leaving the country for a short period. The subscriber has a monthly service plan that charges $40 on the 1st of every month. On July 27, the subscriber requests to have her monthly plan suspended on August 5. On July 27, you use the SubMan APIs to schedule the suspension for August 5. The offer is suspended on August 5 and a refund of $31.61 is issued.
On July 27, the subscriber requests to have her monthly plan suspended in Pause mode on August 5 and resumed on September 10. On July 27, you use the SubMan APIs to schedule the suspension for August 5. On August 5, the offer is suspended in Pause mode and during the suspension, the subscriber is not charged any monthly fees. The offer resumes on September 10, and the subscriber does not have to pay the $40 monthly fee until October 7.