Get Subscriber Balance

This API is used to retrieve a single subscriber’s balance for Usage or Money type plans.

HTTP URL
GET	/api/v2/subscriber/{type}/{value}/balance/{id}

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requester is eligible to request and retrieve balance information for own subscribers and own sub-customers’ subscribers.

API Request

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
balanceID	UUID	M	Balance universal unique ID
currency	String	M	Monetary: For example, USD, GBP, EUR Allowance: SMS: (Number of) SMSs Data: KB, MB, GB
value	Decimal	M	Balance amount

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1006	Failed to retrieve subscriber details

Examples

Request Body

Response Body: Success ACK

Response Body: Failure NAK