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 Plans v2

An API to retrieve the Plan details of an MTN customer and calculate aYo premiums. Can also be used by 3rd-party partners (3PP) for airtime recharge of a prepaid subscriber **24-June-21: ChangeID: c835ca3** - Added an optional channel parameter on the /customers/{customerId}/plans/refill endpoint **09-August-21: ChangeID: 87f0b10** -...

MTN Plans v2 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, Benin, Cameroon, Congo, and Côte d’Ivoire. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 8 operations across 6 paths, organized into 2 resource areas, and defines 36 schemas. It is described by OpenAPI 2.0, at version v.2.3.

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

8 operations 6 paths 36 schemas 3 GET3 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v.2.3
Base URL
https://api.mtn.com/v2
Authentication
API Key, OAuth 2.0
Resource Areas
2

Authentication & Security 2

MTN Plans v2 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 8

Across 6 paths, the API surfaces 8 operations — 3 GET, 3 PATCH, 2 POST. They span 2 resource areas: Customers, Premiums. Each is listed below with its method, path, parameters, and response codes.

Customers 7
GET
/customers/{id}/plans/FRI
Retrieves a customers FRI
getFRIUsingPOST 5 params → 200400401403404405500
PATCH
/customers/{id}/plans/FRI/state
Block and Unblock operations are initiated on Customer FRI
UpdateFRIUsingPATCH 7 params → 200400401403404405500
GET
/customers/{customerId}/plans
View customer plans
15 params → 200207400401403404405500
PATCH
/customers/{customerId}/plans
Tariff plan migration
trariffMigration 3 params → 200400401403404500503999
GET
/customers/{customerId}/plans/{productCode}
View customer plans for product
2 params → 200207400401403
PATCH
/customers/{customerId}/plans/refill
Airtime Refill
refillAccount 6 params → 200400401403404500503999
POST
/customers/{id}/plans/provision
Provision the customer and return customer details along with MSISDN
getCustomerDetails 5 params → 200400401404415500
Premiums 1
POST
/customers/{customerId}/plans
Request Premium
2 params → 200207400401403404405500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are AdditionalInformationBody (61 properties), Plans (11 properties), customerDetails_Request (11 properties), PremiumRequest (8 properties). Each schema is shown below with its type and property counts.

FinancialResourceInformationRequest
object
3 properties 1 required
FinancialResourceInformationResponse
object
4 properties
PremiumRequest
object
8 properties 5 required
CustomerPremium
object
3 properties 1 required
PremiumData
object
Contains response information pertaining to the premium request.
3 properties
LoyaltyBalances
object
Contains all the loyalty balances associated with a customer.
3 properties
CustomerPlans
object
7 properties 1 required
OfferDetails
object
The Offer Details per customer.
5 properties
MomoBalanceDetail
object
The MoMo Balance details for a requested customer.
6 properties
OverdraftInformation
object
Contains overdraft balances if available
4 properties
Plans
object
The plan details for the customer.
11 properties 7 required
UsageCounterUsageThreshold
object
2 properties
Accumulator
object
4 properties
CustomerBalance
object
The plan balance details for the customer.
8 properties 4 required
AdditionalInformationBody
object
61 properties
BalanceDetail
object
The details for a balance type.
5 properties 3 required
Wallet
object
The details for a wallet account.
4 properties 4 required
Amount
object
The amount details for a wallet.
3 properties 3 required
UsageCounter
object
4 properties
UsageThreshold
object
4 properties
PremiumError
object
4 properties
GetFRIRequest
object
3 properties
SetFRIRequest
object
4 properties
GetFRIResponse
object
4 properties
UpdateFRIRequest
object
3 properties
UpdateFRIResponse
object
4 properties
Links
object
1 property
customerDetails_Request
object
11 properties 1 required
provisionResponse
object
6 properties
Error
object
8 properties 2 required
Error400
object
5 properties
Error401
object
5 properties
Error404
object
5 properties
Error405
object
5 properties
Error415
object
5 properties
Error500
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-mtn-customer-plans-api-v2.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 Plans v2, 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.