Profiles

AVAILABLE IN

Benin Congo (the) Côte d'Ivoire Cameroon Ghana Guinea Guinea-Bissau Liberia Nigeria South Sudan Syrian Arab Republic Eswatini Uganda Yemen South Africa Zambia

Download

Download Postman collection Download Swagger

Available endpoints

GET v1/customers/{customerId}

Description

Retrieves the customer profile of a MTN customer. The customer profile includes 4 main objects: Location (Country and Operator), Billing Plan and related details, Subscriptions for VAS and Digital Services, and Loans details

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

scope string
the set of data to be retrieved. There are 2 options - `basic` will retrieve only the structure of the customer profile including the links to each resource, will `full` will retrieve all the data for each resource, which will be en expensive call. If not specified, the default will be `basic`"
200OK
customerId string
locations
data
country string
The country that the customer MSISDN was provisioned in.
operator string
The network operator that the customer MSISDN was provisioned for.
_link
self
href string
plans
data
type string
The billing type of the plan.
status string
The current status of the plan.
startDate string
The date the customer was created/provisioned
endDate string
The date the plan will be deactivated.
balance
data
balanceType string
Identifies the type of balance. A customer plan may have multiple types of balances for different usage, for example, voice, SMS, and game services.
amount string
Amount of balance.
currency string
ISO 4217 three-letter ISO code for the currency.
expiryDate string
Expiry Date of the account.
_link
self
href string
loans
data
_link
self
href string
status string
transactionId string
_link
self
href string
_links
self
href string
{
    "customerId": "string",
    "locations": {
        "data": {
            "country": "string",
            "operator": "string"
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "plans": {
        "data": {
            "type": "string",
            "status": "string",
            "startDate": "string",
            "endDate": "string",
            "balance": {
                "data": {
                    "balanceType": "string",
                    "amount": "string",
                    "currency": "string",
                    "expiryDate": "string"
                }
            }
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "loans": {
        "data": {
            "_link": {
                "self": {
                    "href": "string"
                }
            },
            "status": "string",
            "transactionId": "string"
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "_links": {
        "self": {
            "href": "string"
        }
    }
}
207Multi-Status
400Bad Request
error string
error_description string
{
    "error": "string",
    "error_description": "string"
}
401Unauthorized
error string
error_description string
{
    "error": "string",
    "error_description": "string"
}
403Forbidden
error string
error_description string
{
    "error": "string",
    "error_description": "string"
}
404Not Found
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}