Home
MATRIXX Subscriber Management API
SubMan API Reference
The SubMan API reference includes SubMan API and MDC descriptions.
Pricing MDCs
This section describes the pricing-related APIs.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
- About Subscriber Management API
  MATRIXX Subscriber Management API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- Subscriber Management
  The following information is an overview of the SubMan APIs and architecture.
- Object Management
  The following sections introduce how the various in-memory objects are managed.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
  - Application MDCs
    The application MDCs include information for each Rx application session in a response for device sessions.
  - Balance, Meter, Wallet MDCs
    This section includes balance-related MDCs.
  - Barclay MDCs
    This section describes the Barclay MDCs.
  - Bundle MDCs
    This section includes the bundle MDCs.
  - Billing MDCs
    This section includes billing-related MDCs.
  - Braintree MDCs
    This section includes the Braintree-specific SubMan APIs.
  - Catalog MDCs
    The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions.
  - Catalog Item MDCs
    The catalog item APIs return information about eligible catalog items for specified devices, groups, and subscriptions.
  - Charge-Related MDCs
    This section describes the charge-related MDCs for MATRIXX API calls.
  - Contract MDCs
    Contract data is returned in the product offer API responses in the MtxPurchasedOfferInfo MDC.
  - Datatrans MDCs
    The Datatrans MDCs include information for the Datatrans Payment Gateway.
  - Data Migration MDCs
    Use the following MDCs to import data for users, subscriptions, groups, and devices and to import catalog item purchase information for a subscription.
  - Device MDCs
    This section lists the device-related MDCs.
  - Diameter MDCs
    This section includes the Diameter-related APIs.
  - Eligibility Rules MDCs
    This section describes the SubMan eligibility rules APIs.
  - Event MDCs
    This section includes the event-related APIs.
  - Evertec MDCs
    This section includes the Evertec-specific SubMan APIs.
  - External Payment MDCs
    External payment APIs query external payment requests and get a list of external payment request records in a wallet.
  - Group MDCs
    This section lists the group-related APIs.
  - Mastercard MDCs
    This section includes the Mastercard-specific SubMan APIs.
  - mPAY MDCs
    This section describes the mPAY MDCs.
  - Multi-Tenant MDCs
    The multi-tenant APIs return tenant information for individual tenants and all tenants.
  - Notification MDCs
    This section includes the notification MDCs.
  - Parameter MDCs
    This section includes the parameter MDCs.
  - Pay Now Payment MDCs
    The Pay Now payment SubMan APIs query payment information and add or remove payment method tokens for subscribers and groups.
  - Policy MDCs
    This section lists the MATRIXX Policy application APIs.
  - Pricing MDCs
    This section describes the pricing-related APIs.
    - MtxParameterData
      A Parameter used by a pricing object. (Either ParameterDefnId or ParameterName must be present.)
    - MtxParameterInfo
      A Parameter used by a pricing object.
    - MtxPricingAttrInfo
      Attribute information for pricing.
    - MtxPricingBalanceClassDetailInfo
      Detailed information on a balance class.
    - MtxPricingBalanceClassInfo
      Basic information on a balance class.
    - MtxPricingBalanceClassSearchData
      Common structure for operations that need to lookup a balance class.
    - MtxPricingBalanceDetailInfo
      Information on the balance.
    - MtxPricingBalanceInfo
      Information on the balance.
    - MtxPricingBalanceSearchData
      Common structure for operations that need to lookup a balance.
    - MtxPricingBillingCycleDetailInfo
      Detailed billing cycle information.
    - MtxPricingBillingCycleInfo
      Basic billing cycle information.
    - MtxPricingBillingCycleSearchData
      Common structure for operations that need to lookup a billing cycle.
    - MtxPricingBundleDetailInfo
      Detailed information on bundle.
    - MtxPricingCatalogItemDetailInfo
      Detailed information about a catalog item.
    - MtxPricingCatalogItemInfo
      Basic information about a catalog item.
    - MtxPricingCatalogItemSearchData
      Structure for operations that need to lookup a catalog item.
    - MtxPricingContractEtcScheduleInfo
      Contract early termination charge schedule returned in query response
    - MtxPricingContractEtcScheduleRangeInfo
      Contract ETC schedule returned in query response
    - MtxPricingContractEtcScheduleSearchData
      Structure for operations that need to lookup a contract ETC schedule.
    - MtxPricingContractInfo
      Detailed information about a contract.
    - MtxPricingContractSearchData
      Structure for operations that need to lookup a contract.
    - MtxPricingEligibilityDecimalRule
      A Catalog Item rule with an DECIMAL value
    - MtxPricingEligibilityFeature
      Base MDC for Catalog Item feature of a specific type.
    - MtxPricingEligibilityInt64Feature
      A Catalog Item feature with an INT64 value
    - MtxPricingEligibilityInt64Rule
      A Catalog Item rule with an INT64 value
    - MtxPricingEligibilityRule
      Base MDC for a Catalog Item eligibility rule of a specific type.
    - MtxPricingEligibilityStringFeature
      A Catalog Item feature with an STRING value
    - MtxPricingEligibilityStringRule
      A Catalog Item rule with an STRING value
    - MtxPricingEligibilityDecimalFeature
      A Catalog Item feature with an DECIMAL value
    - MtxPricingEventFieldMapInfo
      Information on an event field mapping.
    - MtxPricingEventTypeDetailInfo
      Detailed information on an event type.
    - MtxPricingEventTypeInfo
      Basic information on an event type.
    - MtxPricingEventTypeSearchData
      Common structure for operations that need to lookup an event type.
    - MtxPricingFinanceContractInfo
      Specific information about a finance contract returned in query response
    - MtxPricingLifecycleProfileInfo
      Basic information on a status lifecycle profile.
    - MtxPricingNotificationProfileData
      Structure to define type, offset type and offset.
    - MtxPricingNotificationProfileInfo
      Notification Profile Information.
    - MtxPricingNotificationProfileSearchData
      Operations that need to lookup a Notification Profile.
    - MtxPricingOfferDetailInfo
      Detailed information on offer.
    - MtxPricingOfferInfo
      Basic information on offer or bundle.
    - MtxPricingOfferSearchData
      Common structure for operations that need to lookup a product offer or bundle.
    - MtxPricingOfferVersionInfo
      Basic information on an offer or bundle version.
    - MtxPricingRateTagInfo
      Information on a rate tag.
    - MtxPricingRateTagSearchData
      Common structure for operations that need to lookup a rate tag.
    - MtxPricingRoleDetailInfo
      Detailed information about a role object.
    - MtxPricingRoleInfo
      Basic information about a role object.
    - MtxPricingRoleSearchData
      Common structure for operations that need to lookup a role.
    - MtxPricingServiceContextDetailInfo
      Detailed service context information.
    - MtxPricingServiceContextInfo
      Basic service type context information.
    - MtxPricingServiceContextSearchData
      Common structure for operations that need to lookup a service type's context.
    - MtxPricingServiceContractInfo
      Specific information about a service contract returned in query response
    - MtxPricingServiceTypeDetailInfo
      Detailed information on a service type.
    - MtxPricingServiceTypeInfo
      Basic information on a service type.
    - MtxPricingServiceTypeSearchData
      Common structure for operations that need to lookup a service type.
    - MtxPricingSessionFieldMapInfo
      Information on a session field mapping.
    - MtxPricingStatusInfo
      Information on a particular status value.
    - MtxPricingStatusTransitionInfo
      Information on a particular status lifecycle transition.
    - MtxPricingTaxClassDetailInfo
      Detailed information on a tax class.
    - MtxPricingTaxClassInfo
      Basic information on a tax class.
    - MtxPricingTaxClassSearchData
      Common structure for operations that need to lookup a tax class.
    - MtxPricingThresholdInfo
      Information on a threshold.
    - MtxRequestPricingQueryBalance
      Query for information on a balance.
    - MtxRequestPricingQueryBalanceClass
      Query for information on a balance class.
    - MtxRequestPricingQueryBalanceClassList
      Query the list of active balance classes.
    - MtxRequestPricingQueryBalanceList
      Query the list of active balances.
    - MtxRequestPricingQueryBalanceThresholdList
      Query for information on a balance's thresholds.
    - MtxRequestPricingQueryBillingCycle
      Query for information on a billing cycle.
    - MtxRequestPricingQueryBillingCycleList
      Query the list of active billing cycles.
    - MtxRequestPricingQueryCatalog
      Request to get detailed information on the specified Catalog.
    - MtxRequestPricingQueryCatalogList
      Request to get list of all available Catalogs
    - MtxRequestPricingQueryCatalogItem
      Request to query individual catalog item for detailed information.
    - MtxRequestPricingQueryCatalogItemList
      Request to get the basic information for all catalog items.
    - MtxRequestPricingQueryContract
      Request to query individual contract for information.
    - MtxRequestPricingQueryContractEtcSchedule
      Request to query individual contract ETC schedule for information.
    - MtxRequestPricingQueryContractEtcScheduleList
      Request to get the information for all contract ETC schedules.
    - MtxRequestPricingQueryContractList
      Request to get the information for all contracts.
    - MtxRequestPricingQueryEventType
      Query for information on an event type.
    - MtxRequestPricingQueryEventTypeList
      Query the list of active event type objects.
    - MtxRequestPricingQueryLifecycle
      Query the status lifecycle of a object type.
    - MtxRequestPricingQueryLifecycleProfileList
      Query the list of status lifecycle profiles of an object type.
    - MtxRequestPricingQueryNotificationProfile
      Query for information on a Notification Profile.
    - MtxRequestPricingQueryOffer
      Query an active offer or bundle.
    - MtxRequestPricingQueryOfferList
      Query the list of active offers and bundles.
    - MtxRequestPricingQueryRateTag
      Query for information on a rate tag.
    - MtxRequestPricingQueryRateTagList
      Query the list of active rate tags.
    - MtxRequestPricingQueryRole
      Request to query individual role for information.
    - MtxRequestPricingQueryRoleList
      Request to get the information for all roles.
    - MtxRequestPricingQueryServiceContext
      Query for information on a service type's context.
    - MtxRequestPricingQueryServiceType
      Query for information on a service type.
    - MtxRequestPricingQueryServiceTypeList
      Query the list of active service types.
    - MtxRequestPricingQueryStatus
      Query the active pricing for status.
    - MtxRequestPricingQueryTaxClass
      Query for information on a tax class.
    - MtxRequestPricingQueryTaxClassList
      Query the list of active tax classes.
    - MtxResponsePricingBalance
      Information on balance.
    - MtxResponsePricingBalanceClass
      Information on a balance class.
    - MtxResponsePricingBalanceClassList
      Information on active balance classes.
    - MtxResponsePricingBalanceList
      Information on active balances.
    - MtxResponsePricingBalanceThresholdList
      Information on a balance's thresholds.
    - MtxResponsePricingBillingCycle
      Information on a billing cycle.
    - MtxResponsePricingBillingCycleList
      Information on active billing cycles.
    - MtxResponsePricingCatalog
      Response with detailed information on a Catalog.
    - MtxResponsePricingCatalogList
      Response with basic information about all catalogs.
    - MtxResponsePricingCatalogItem
      Response to a detailed query of a specific catalog item.
    - MtxResponsePricingCatalogItemList
      Response with basic information about all catalog items.
    - MtxResponsePricingContract
      Response to a query of a specific contract.
    - MtxResponsePricingContractEtcSchedule
      Response to a query of a specific contract ETC schedule.
    - MtxResponsePricingContractEtcScheduleList
      Response with information about all contract ETC schedules.
    - MtxResponsePricingContractList
      Response with information about all contracts.
    - MtxResponsePricingEventType
      Information on an event type.
    - MtxResponsePricingEventTypeList
      Information on active event types.
    - MtxResponsePricingLifecycle
      Status lifecycle for a particular object type.
    - MtxResponsePricingLifecycleProfileList
      Information on status lifecycle profiles.
    - MtxResponsePricingNotificationProfile
      Response to Notification profile query
    - MtxResponsePricingOffer
      Information on an offer or bundle.
    - MtxResponsePricingOfferList
      Information on active offers and bundles.
    - MtxResponsePricingRateTag
      Information on a rate tag.
    - MtxResponsePricingRateTagList
      Information on active rate tags.
    - MtxResponsePricingRole
      Response to a query of a specific role.
    - MtxResponsePricingRoleList
      Response with information about all roles.
    - MtxResponsePricingServiceContext
      Information on a service type's context.
    - MtxResponsePricingServiceType
      Information on a service type.
    - MtxResponsePricingServiceTypeList
      Information on active service types.
    - MtxResponsePricingStatus
      Information on loaded pricing.
    - MtxResponsePricingTaxClass
      Information on a tax class.
    - MtxResponsePricingTaxClassList
      Information on active tax classes.
    - MtxRoleData
      Data on role to add to or remove from a user relationship.
    - MtxSampleTemplateAttr
      Sample set of template parameters for customizing offer/bundle templates
    - MtxTemplateAttr
      Base container which can be extended to specify custom attributes for offer/bundle templates
  - Product Offer MDCs
    This section describes the product offer-related APIs.
  - Purchase Package MDCs
    Use the purchase package MDCs to manage catalog items in a purchase package, including adding and removing catalog items for subscriptions, groups, and devices, and suspending, resuming, and canceling purchase packages.
  - Purchased Item MDCs
    This section lists the purchased item APIs.
  - Recharge MDCs
    This section describes the recharge MDC fields.
  - Rehoming MDCs
    The rehoming APIs move a _glossary/subscription.html, group, or device from one customer sub-domain to a different sub-domain. For a description of the rehoming process, see the discussion about rehoming subscribers, groups, and devices in the object management overview.
  - Related Objects
    This section describes the common structures for related objects, related subscription objects, and related user objects.
  - Request/Response MDCs
    This section includes request and response APIs.
  - Roaming MDCs
    This section describes the roaming MDCs.
  - Romcard V2 MDCs
    This section describes the Romcard V2 MDCs.
  - Security MDCs
    The ApiEventSecurityInfo MDC records client security information.
  - Status MDCs
    The status APIs change the status of existing subscriptions, groups, and devices. They cancel any scheduled status change for a purchased item (offer or bundle) from subscriptions, groups, and devices. They cancel any scheduled status change for subscriptions, groups, and devices.
  - Subscriber MDCs
    This section lists the subscriber-related APIs.
  - Subscription MDCs
    The subscription APIs create, delete, modify, and query subscription objects.
  - Subscription/Group Membership MDCs
    This section describes the subscription/group membership MDC.
  - Tax MDCs
    This section lists the tax APIs.
  - Tenant MDCs
    This section lists the tenant APIs.
  - User MDCs
    This section describes the user object APIs.
  - MtxOpMsg
    MDC container for request/response handling.
- REST API Management
  RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. RS Gateway consists of an rsgateway application and a set of REST APIs.
- REST API Reference
  This part describes how to use the REST API bindings to interface with MATRIXX Engine.
- Java API
  This part provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Pricing MDCs

This section describes the pricing-related APIs.

Pricing query operations include a TenantId field. The is a unique ID created by a service provider to uniquely identify a tenant across all domains. Only values within an existing MtxTenantProfile can be used. When querying pricing, if a tenant has its own pricing file (a tenant pricing file), only data from that file is returned. If a tenant is managed by the enterprise, only data from the base pricing file is returned. The TenantId is optional. If you do not specify a TenantId, only data from the base pricing file is returned. The MtxResponse MDC includes the TenantId for user, subscription, group, device, and account objects. For more information about multi-tenancy, see the discussion about multi-tenancy in MATRIXX Pricing and Rating. For information about creating tenant profiles and creating tenant IDs, see the discussion about tenant profiles in My MATRIXX Help.