Creating Purchase Packages

Create a new purchase package by specifying the purchase package data in the PurchasePackageData parameter in the PurchaseOffer API request. After the purchase package is created, all catalog items purchased in the PurchaseOffer request are associated with the new purchase package. For a complete list of PurchasePackageData parameters, see the discussion about MtxPurchasePackageData in MATRIXX Subscriber Management API.

If the purchase package cycle has the same period type and period interval as the billing cycle, it can have its recurring cycle aligned to the billing cycle by specifying the CycleOffsetType parameter as billing_cycle in the purchase package cycle data in the PurchaseOffer API request. To align an existing purchase package cycle with the billing cycle, use the ModifyPurchasePackage APIs. If the billing cycle is modified, purchase packages that are aligned to the billing cycle are updated to have the same cycle definition as the billing cycle. For more information about modifying a purchase package, see the discussion about modifying purchase packages.

For an existing purchase package, specify the purchase package resource ID in the PurchasePackageResourceId parameter in the PurchaseOffer request. All catalog items being purchased in the PurchaseOffer API request are associated with the existing purchase package.

For more information about the PurchaseOffer APIs, see the discussions about MtxRequestSubscriberPurchaseOffer, MtxRequestGroupPurchaseOffer, and MtxRequestDevicePurchaseOffer in MATRIXX Subscriber Management API.

Promotional Purchase Package

In this example, a service provider offers a holiday package to subscribers called UltimateHolidayPurchasePackage which includes a promotional discount, as shown in Figure 1.
Figure 1. Promotional Purchase Package Catalog Item Selection

Promotional Purchase Package Catalog Item Selection
  1. A mobile application presents a list of catalog items for the subscriber to purchase.
  2. The subscriber makes their selection.
  3. An MtxRequestSubscriberPurchaseOffer is submitted with the list of selected catalog items.
  4. Purchase offer is submitted.
  5. A catalog item with a discount component for the holiday promotion is added to the list of catalog items.
  6. The purchase package containing the catalog items is created.
  7. The catalog items are purchased as a purchase package (a unit), and recurring processing is done as a unit.