GET /v1/balance
Tagastab arvelduskonto saldo kümnendstringina.
GET /v1/balance
See kirjutuskaitstud lõpp-punkt kinnitab API võtme, kuid ei nõua positiivset saldot.
Taotlus
curl https://api.model-gate.com/v1/balance \
-H "Authorization: Bearer mg_live_..."
Vastus
{
"object": "balance",
"currency": "USD",
"balance": "12.3400000000"
}
Individuaalsete mandaatide puhul kuulub saldo kasutajale, kellele võti kuulub. Ettevõtte mandaatide puhul kasutavad API tasud alati ettevõtte omaniku rahakotti. Jagatud ettevõtte saldo tagastatakse ainult siis, kui mandaadi käsundiandjal on ettevõtte tasemel saldo nähtavus (organisatsiooni omanik, administraator või arveldusroll). Töötaja arendaja/vaataja mandaadid võivad täita lubatud API päringuid, kuid saada HTTP 403 /v1/balance; need kasutajad näevad juhtpaneelil ainult nende lubatud rühmakasutust ja piiranguid. API-võti usage ja spend_limit jäävad eraldi väärtusteks.
Autentimisviga
{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "invalid API key"
}
}
Ettevõtte loa viga
{
"error": {
"type": "permission_error",
"code": "balance_not_permitted",
"message": "Company balance is not available for this credential principal."
}
}