Usage Consumption Biz API

Brief Description

This API covers the consumption follow up function providing ongoing information about usages related to any subscribed network products (voice, data, TV,…) without having to wait the invoice production. These information may concern usages charged on a bucket supervised or not and so the remaining credits on the bucket. It allows customers or users to be informed on usages done and remaining credits on the buckets that they consume under their purchased offers and options.
A bucket is a quantity of units (time, volume, currency or events) available via a subscribed offer or option and that can be consumed during a validity period. A bucket has at least one balance valid at a given point. This balance is decremented by usage charged on the bucket and incremented by credit operations (like top-up operations for example). At a given point, this balance defines the remaining allowed usage quantity for a given period, corresponding to the initial allowed usage quantity minus consumed usage quantity.
The bucket has also consumption counters which give measures about the usage quantity consumed on the bucket. These counters can be detailed by device or by user for example when a bucket is shared between several devices or several users.
The usage consumption API allow to view at a given point the balance and the consumption counters of the various buckets (SMS, Voice, Data for example) that one or more user(s) consume with each of his devices, according to the purchased offers and options.
A usage consumption report retrieves the data related to these balances and various consumption counters and calculated at the time of the request by the server.

This API exposes following resources

Get Usage Consumption Report

This resource fetch usage consumption summary from Matrixx system

Criticality

Medium

Layer/Category

Biz

API Current State

Development Phase

Usage

TBD

Base URI Summary of Methods

1. Development:
2. TEST:
3. PREPROD:
4. PROD:

Transport Protocol(s)

HTTP

HTTPS

3 Layer architecture flow diagram

Sequence Diagram

TBD

Quality of Service (QoS)

TBD

Avg. Response Time (Secs)

TBD

Avg. Payload Size (KB/MB)

TBD

Max Payload Size (KB/MB)

TBD

Avg. Volumes (per day)

TBD

Peak Volumes

TBD

Peak Volumes Timespan

TBD

Availability

High Availability

Service Level Agreement

N/A

Policies

N/A

GDPR

TBD

Constraints

There are no constraints applicable to this API.

Assumptions

Average/Peak Response time depends on the size of payload and speed and other network and processing factors.

Reference documents