Plans

AVAILABLE IN

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

Download

Download Postman collection Download Swagger

Available endpoints

GET v1/customers/{customerId}/plans

Description

Retrieves the Billing Plan and related details of an MTN customer.

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key
200OK
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.
language string
The customers language.
balance
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 integer
Current balance on the customers account.
currency string
ISO 4217 three-letter ISO code for the currency.
expiryDate string
Expiry date of the balance/bundle.
_link
self
href string
{
    "data": {
        "type": "string",
        "status": "string",
        "startDate": "string",
        "endDate": "string",
        "language": "string",
        "balance": {
            "balanceType": "string",
            "amount": 1,
            "currency": "string",
            "expiryDate": "string"
        }
    },
    "_link": {
        "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"
}