Activation with the SubMan APIs

You can use the SubMan APIs to activate a pre-active purchased item by changing the Status field to purchased.

You cannot activate a purchased offer that is a part of a purchased bundle.

In the request to modify a purchased item, you can modify the purchased item cycle if the ModifyAllowed field in MtxPurchasedItemCycleInfo is true.

Use the SubMan APIs in SubMan ModifyOffer APIs to activate a pre-active purchased item. When the request is successful, an MtxPurchasedItemActivationEvent Event Detail Record (EDR) is generated.

If activation fails:
  • For insufficient funds, the response includes CREDIT_LIMIT_REACHED (38).
  • When a balance threshold is crossed, the response includes BALANCE_FLOOR_REACHED (81).
  • When the request causes an invalid life cycle state, the response includes PERMISSION_DENIED (33).
Table 1. SubMan ModifyOffer APIs
SubMan API Description
MtxRequestGroupModifyOffer Request that information about an existing purchased catalog item for a group is modified.
MtxRequestSubscriberModifyOffer Request that information about an existing purchased catalog item for a subscription is modified.
MtxRequestDeviceModifyOffer Request that information about an existing purchased catalog item for a device is modified.

For more information about the SubMan APIs, see MATRIXX Subscriber Management API.