Get Account Status

Method

GET

Path

account/status

Request Parameters

None

Response

A JSON object with success, message, and data attributes. The data attribute contains the following values:

Name Description
balance Your current account funds balance in cents
faxes_today A hash of the number of faxes sent and received today
faxes_this_month A hash of the number of faxes sent and received this month

Sample Call

curl -u 'API_KEY:API_SECRET' https://api.phaxio.com/v2.1/account/status

Sample Response

{
    "success":true,
    "message":"Account status retrieved successfully",
    "data":{
        "balance":5050,
        "faxes_today":{
            "sent":1,
            "received":2
        },
        "faxes_this_month":{
            "sent":15,
            "received":7
        }
    }
}