TMF677 Usage Consumption Management API

The TMF677 usage consumption management API supported by MATRIXX provides a standardized mechanism for retrieving usage consumption data associated with a subscription.

The TMF677 specification describes two modes of operation: synchronous and asynchronous. TMF Gateway provides support only for the synchronous model, using only the QueryUsageConsumption POST operation.

Use TMF usage consumption queries to request usage consumption data for one or more subscriptions up to a maximum of 10. The data returned can include usage related balances, such as amounts used, amounts remaining, and the associated dates.

When requesting usage consumption data for a subscription, the subscription must exist in the MATRIXX database. In addition, the following rules apply to the request body:
  • In the request body, include only a searchCriteria object that has only a service array within it.
  • The service array must not be empty. It can have a size of between one and 10 objects.
  • Each object in the service array must contain exactly one unique ID. The ID must follow the MATRIXX objectId format and it must be able to retrieve a MATRIXX subscription.

The usage consumption query response provides real-time value within buckets (for example for SMS, Voice, Data, or TV usage) that a customer consumes with each device, without having to wait for the bill cycle.

For information about the TMF677 usage consumption management API, see TM Forum Usage Consumption Management API User Guide, TMF677 release 20.5 version 4.0.0.