Skip to main content
GET
/
environment
/
balance
Get Environment Balance
curl --request GET \
  --url https://api.mintfax.com/v1/environment/balance \
  --header 'Authorization: Bearer <token>'
{
  "available": 123,
  "held": 123,
  "auto_top_up": {
    "enabled": true,
    "threshold_amount": 123,
    "package_id": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Response

BalanceResource

​
type
enum<string>
required

Balance type.

Available options:
live,
sandbox
Example:

"sandbox"

​
available
integer
required

Credits available for new faxes, in cents.

Example:

4550

​
held
integer
required

Credits held for in-flight faxes, in cents.

Example:

450

​
auto_top_up
object
required
Last modified on May 21, 2026