Balance API

MessageBird provides an API to get the balance and balance information of your account.

URI

https://rest.messagebird.com/balance

Available HTTP Methods

GET /balance

The balance object

This object represents your balance at MessageBird.com

Attributes

AttributeTypeDescription
paymentstringYour payment method. Possible values are: prepaid & postpaid
typestringYour payment type. Possible values are: credits, euros, pounds & dollars. For all other supported currencies, an ISO-4217 code is returned.
amountfloatThe amount of balance of the payment type. When postpaid is your payment method, the amount will be 0.

Object example

{
"payment": "prepaid",
"type": "euros",
"amount": 103
}

Get your balance

Retrieves your MessageBird balance.

Example request

curl -X GET https://rest.messagebird.com/balance \ -H 'Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM'

Returns

Returns a balance object if the request was successful. If the request failed, an error object will be returned.

Object example

{
"payment": "prepaid",
"type": "euros",
"amount": 103
}
cURL
PHP
Node
C#
Java
Ruby
Go
Python
Cookie Settings