Get account status
Operation
accountStatus
Parameters
Name | Type | Description |
---|---|---|
api_key | string | Your api key |
api_secret | string | Your api secret |
Response
A JSON object with success
, message
, and data
attributes.
The data attribute is constructed as follows:
Name | Type | Description |
---|---|---|
faxes_sent_this_month | integer | Number of faxes sent this month |
faxes_sent_today | integer | Number of faxes sent today |
balance | integer | Account balance in cents |
Sample Call
curl https://api.phaxio.com/v1/accountStatus \
-F 'api_key=API_KEY' \
-F 'api_secret=API_SECRET'
Sample Response
{
"success":true,
"message":"Account status retrieved successfully",
"data": {
"faxes_sent_this_month":120,
"faxes_sent_today":10,
"balance":3000
}
}