How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MTN Usage Consumption V1

API to fetch Airtime, Currency, Voice, Data and SMS balance details for a subscriber.

MTN Usage Consumption V1 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers and Rwanda. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://api.mtn.com/usageConsumption/v1/.

2 operations 2 paths 11 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.mtn.com/usageConsumption/v1/
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN Usage Consumption V1 declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It supports OAuth 2.0 (OAuth2) using the application flow. By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

usageConsumptionReport 2
GET
/usageConsumptionSummary/{id}
Retrieves a usage consumption summary of a subscriber
retrieveUsageConsumptionSummary 5 params → 200400401403404405409500
GET
/usageConsumptionDetailedReport/{id}
Retrieves a usage consumption Detailed Report of a subscriber
retrieveUsageConsumptionDetailedReport 5 params → 200400401403404405409500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EntityRef (10 properties), Bucket (9 properties), UsageConsumptionSummary (7 properties), UsageConsumptionDetailedReport (7 properties). Each schema is shown below with its type and property counts.

ResponseUsageConsumptionSummary
object
4 properties 4 required
ResponseUsageConsumptionDetailedReport
object
4 properties 4 required
UsageConsumptionSummary
object
An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example…
7 properties
UsageConsumptionDetailedReport
object
An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example…
7 properties
Bucket
object
An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example…
9 properties
EntityRef
object
An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example…
10 properties
UsageVolumeProduct
object
A bucket (called UsageVolumeProduct in the SID model) represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a qua…
5 properties
UsageVolumeBalance
object
The balance (called UsageVolumeBalance in the SID model) defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It…
4 properties
Quantity
object
An amount in a given unit
2 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
Error
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-usage-consumption.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
MTN TMF Customer Bill Management - TMF678
MTN Loans
MTN Subscriber Details
MTN Subscriber Type
MTN Provisioning
MTN Unified Balance V1
MTN TMF Resource Inventory Management - TMF639
MTN Sales Lead
MTN Service Activation and Configuration
MTN Service Ordering
MTN BSS TT OAuth V1
Where this information came from

This is an independent, third-party profile of MTN Usage Consumption V1, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.