Home
MATRIXX Subscriber Management API
REST API Reference
This part describes how to use the REST API bindings to interface with MATRIXX Engine.
My MATRIXX REST APIs
My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
Normalizer REST Bindings
The normalizer REST bindings get, create, and update normalizers.

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.
- 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.
  - Deprecated APIs
    The following APIs are deprecated in this release of MATRIXX and support for these APIs will be removed in a future release.
  - Balance, Meter, and Wallet REST APIs
    The balance management APIs include the messaging required to operate on a balance, meter, or wallet object. The primitives include the messaging and data elements required to create, modify, associate, and query objects directly related to a balance or meter, including their thresholds.
  - Catalog REST APIs
    The catalog APIs return information about pricing catalogs for specified devices, groups, and subscriptions. They return catalog items that the specified object is eligible to purchase.
  - 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 REST APIs
    The device management APIs include the methods and functions required to operate on the device primary object. They include the data elements required to create, modify, and query devices, to add and remove a device from a subscription, and to delete a device from the Subscriber database.
  - Eligibility Rules REST APIs
    This section describes the APIs for querying catalog items based on eligibility. The APIs return catalog items that the specified object is eligible to purchase.
  - Event REST APIs
    The event APIs include the messaging and elements to return events and notifications in the Event Repository and the event database for subscriptions, groups, and users.
  - External Payment REST APIs
    External payment APIs query external payment requests and get a list of external payment request records in a wallet.
  - Gateway REST APIs
  - Group REST APIs
    The group management APIs include the messaging required to operate on the group object. The APIs include the messaging and data elements required to create, modify, associate, and query objects directly related to the group.
  - Multi-Tenant REST APIs
    The multi-tenant APIs get tenant information for individual tenants and all tenants.
  - My MATRIXX REST APIs
    My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.
    - List Queries
      List queries return information about service types, normalizers, product offers, price components, and rate tables.
    - Catalog Item REST Bindings
      The REST bindings described in this section operate on catalog items in My MATRIXX.
    - Matrix REST Bindings
      The Matrix REST bindings create and update rate tables.
    - Normalizer REST Bindings
      The normalizer REST bindings get, create, and update normalizers.
      - Basic Normalizer
        The REST binding for a basic normalizer flow can use any normalizer in its raw XML form. The sample in this section describes how to create and modify a device type normalizer using the string match normalization algorithm.
      - Apn Normalizer
        The Apn normalizer binding creates a normalizer to map access point names into defined values for pricing.
      - Country Code Determination Normalizer
        The country code determination (CCD) normalizer determines country code zones.
      - IP Mapping Normalizer
        The IP mapping normalizer maps IP addresses into MCC codes.
      - Restricted IP Normalizer
        The restricted IP normalizer determines whether an IP address is in a restricted list.
      - Zone Normalizer
        The Zone Normalizer flow is used to normalize an incoming field on the Diameter Ro message and determine the pricing zone that should be applied.
    - Product Offer REST Bindings
      The product offer REST bindings create new product offers, return information about existing product offers, and update existing product offers.
    - Price Component REST Bindings
      The price component REST bindings create new price components, return information about existing price components, and update existing price components. Price components are always based on usage.
    - Service Type Beats
      Use the service type REST binding to query a service type definition and the beats defined for it.
  - Offer Life Cycle REST APIs
    Use these APIs to query a list of status life cycles for an offer. You can query specific offer status life cycle using the profile ID.
  - Pay Now REST APIs
    The integration layer REST APIs manage payment authorization tokens for the payment gateway from the integration layer. These tokens are necessary for the client to communicate directly with the payment gateway to create a payment method in the payment gateway.
  - Policy REST APIs
    The policy APIs allow you to query the Sy policy counters for a specific device.
  - Pricing REST APIs
    The pricing management APIs return information about all aspects of pricing, including catalog items, balance templates, product offers, billing cycles, life cycles, notifications and so forth. You can also get status information for the currently-loaded pricing.
  - Product Offer REST APIs
    The product offer management APIs include the messaging to activate, purchase, cancel, and modify catalog items. You can identify a product offer by its object ID or the external ID assigned during pricing plan creation.
  - Purchase Package REST APIs
    Use the purchase package APIs 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.
  - Recurring Charge
    The MtxRequestSubscriberEstimateRecurringCharge SubMan API estimates balance impacts from recurring processing of currently failing recurring cycles and upcoming recurring cycles (active purchased items cycles, balance cycles and billing cycles).
  - Rehoming REST APIs
    The rehoming APIs move a subscription, group, device, or user from one customer sub-domain to a different sub-domain. For a description of the rehoming process, see the discussion about rehoming subscribers, groups, devices, and users in the object management overview.
  - Service APIs
    The extended REST service APIs are implemented only in the RS Gateway. These APIs include REST services that manage subscribers, groups, and devices, including rehoming operations. In addition, you can start and stop rating sessions using the service APIs. Unlike the APIs described in MATRIXX Subscriber Management API, these APIs do not have a Python or Java equivalent. For information about the service API default filters, see the discussion about REST filters.
  - Status Life Cycle REST APIs
    Use these APIs to query status life cycle information for devices, groups, subscriptions, and users from the engine.
  - Status Modify APIs
    The status modify APIs schedule status changes and delete scheduled status changes. They also suspend and resume purchased items (product offer or bundle) if the current offer status class permits the action.
  - Subscriber REST APIs
    The Subscriber REST APIs described here are deprecated and will be removed in a future release.
  - Subscription REST APIs
    The subscription management APIs include the messaging required to operate on the subscriber object, which is a primary object for MATRIXX interactions. The API bindings include the messaging and data elements required to create, modify, and query objects directly related to the subscription. A subscription must have a wallet secondary object, which is created for the subscription at subscription creation time.
  - System REST APIs
    The system REST APIs query the MATRIXX Engine to check if recurring recharge is enabled, return domain and sub-domain information, return tenant IDs, and create Pay Now client tokens.
  - Tax REST APIs
    The tax APIs manage information in the US Tax database.
  - User REST APIs
    Use the User REST APIs to add, update, query, and delete users. You can also get and modify user authentication data, associate users with groups and subscriptions, and modify or remove those associations.
- 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

Normalizer REST Bindings

The normalizer REST bindings get, create, and update normalizers.

Attention: MATRIXX Support recommends that you do not create or update rate tables using this API. You should create rate tables in My MATRIXX because it provides safeguards and validations when creating and updating rate tables that the My MATRIXX REST bindings do not.

You can configure the following with the normalizer REST bindings:

Name
EffectiveDate
ValueList
ResultList (determined by the type of normalizer)
NormalizerList (multiplexing normalizers only)
DefaultMetadataArray

The normalizer REST bindings support the following attributes:

algorithm
datatype
name
description
type (This attribute is obsolete. Use the type_id attribute when creating or updating normalizers.)
type_id (Must be a valid normalizer type ID.)
external_id
selectedBalance
selectedBalanceTag
selectedBalanceClass
normalized_value
units
default
no_field_normalization_value
null_balance_value
max_thresholds
threshold_type
threshold_container
threshold_value
effective_date
tier
quantity_unit
is_prefix_match
is_case_sensitive
match_mode
feature_id
feature_value

The following attributes are used only in balance difference normalizers:

balance_class_1
balance_template_1
tier_1
balance_tag_1
from_period_1
to_period_1
balance_class_2
balance_template_2
tier_2
balance_tag_2
from_period_2
to_period_2
normalizer_value_list_id (Used when the normalizer uses a normalizer value list to supply the values for the normalizer. Must be a valid normalizer value list ID.)

The following are used only in difference range normalizers:

FieldOrParameter1
FieldOrParameter2
DifferenceRangeArray

The following examples show how to use the REST bindings on specific types of normalizers. The basic normalizer flow does everything shown in the other examples, but in a general way. These examples are specific use cases.