Events and Notifications
Events and notifications are generated for purchase packages.
Events
If an applied offer is part of a purchase package, information about the purchase
package is included in the AppliedPurchasePackageArray field in
MtxPrimaryEvent.
When Automatic Recurring Recharge is enabled at the system level, and balances used to pay for recurring charges are funded by External Payment Requests, ExternalPaymentRequest events are generated before the start time of each purchase package cycle. For more information, see the discussion about external payment requests.
Notifications
Use notification types to configure the contents of each notification, including purchase package arrays. A purchase package array adds to the configurable contents. For more information about offer and bundle notification types and associated MDCs, see the discussion about notification types and MDCs in My MATRIXX Help.
Notifications that contain offer or bundle information include purchase package information if the offer or bundle is part of a purchase package.
Notification profiles specified for a purchase package determine when notifications must be sent.
Purchase Package-Related Notifications lists notifications generated for purchase packages if notifications are enabled.
| Notification | Description |
|---|---|
| MtxPurchasePackagePurchaseNotification | If the PurchaseOffer request specifies a purchase package, an MtxPurchasePackagePurchaseNotification is generated and includes each purchased catalog item within the purchase package. |
| MtxRecurringChargeNotification | For recurring notification and recurring advance notification of a purchase package, an MtxRecurringChargeNotification is generated before cycle renewal time and has a list of purchased items and the purchase package information. |
| MtxRecurringFailureNotification | For purchase package recurring failure notification, an
MtxRecurringFailureNotification is generated after failed recurring
processing and has a list of purchased items and the purchase
package information. Note: If a purchased item
is in a recoverable state when recurring processing fails, a
recurring failure notification and event are not
generated. |
| MtxRecurringRechargeNotification | For purchase package auto recurring recharge advance notification, an MtxRecurringRechargeNotification is generated before cycle renewal time and includes the list of purchased items and the purchase package information. |
| MtxPurchasePackageCancelNotification | If the notification type subscriber_purchase_package_cancel, group_purchase_package_cancel, or device_purchase_package_cancel is enabled, when a purchase package is canceled, an MtxPurchasePackageCancelNotification is generated. |
| MtxPurchasePackageSuspendNotification | When a purchase package is suspended (the purchase package resource ID is passed to the SuspendOffer API), an MtxPurchasePackageSuspendNotification is generated. |
| MtxPurchasePackageResumeNotification | When a purchase package is resumed (the purchase package resource ID is passed to the ResumeOffer API), an MtxPurchasePackageResumeNotification is generated. |
|
Notifications that contain offer or bundle information include purchase package information if the offer or bundle is part of a purchase package and include an MtxNotificationPurchasePackageInfo which lists the purchase package information contained in the notification. |