Salesforce Docs Portal

MtxRequestSubscriberPurchaseOffer (Managed Package)

This Matrixx API creates a purchase bundle or offer for a subscription in the Matrixx instance. It is used for the SIM Only offer as well as for add-on offers and bundle top-ups. In the sample request shown here a bundle offer code is used.

Managed Package Icon This feature is part of the Communications Cloud managed package.

Sample Request

For a SIM Only offer:

{
	"SubscriberId": "Sub-95b70caa-2087-7446-8359-ef8cc9a3357e",
	"$": "MtxRequestSubscriberPurchaseOffer",
	"OfferRequestArray": [{
		"$": "MtxPurchasedOfferData",
		"ExternalId": "OFF_VCPS_SIMONLYOFFER"
	}]
}

For a bundle offer:

{
	"body": {
		"$": "MtxRequestSubscriberPurchaseOffer",
		"OfferRequestArray": [{
			"$": "MtxPurchasedOfferData",
			"ExternalId": "OFF_VCPS_ADDON_500M500T"
		}]
	}
}

To get the updated balance:

  • HTTP Path: /service/subscriber/ExternalId+%SubscriptionNumber%

  • HTTP Method: GET

  • Named Credential: Matrixx

Called By

  • Workflow: Bulk Upload Preprovisioned Data

    • OmniScript: VPL-CreatePreProvisionedData

      • Integration Procedure: VPL-BulkPostProcess

        • Integration Procedure: VPL-AddSubscription

  • Workflow: Buy Add-On

    • Order Management

  • Workflow: Top-Up Cash Balance

    • OmniScript: VCPS-CashAndBundleTopUps

      • Integration Procedure: VCPS-GetProductMappingAndUpdateMatrixxWrapper

        • Integration Procedure: VCPS-UpdateMatrixxBalanceForBundle

          • Data Mapper: VCPS-BundleTopUpRequest