Skip to main content
GET
/
v1
/
balances
Get current account balance
curl --request GET \
  --url https://api.sfcompute.com/v1/balances \
  --header 'Authorization: Bearer <token>'
{
  "object": "balance",
  "available_cents": 150000,
  "current_cents": 180000,
  "current_overage_cents": 150000,
  "current_hold_cents": 180000,
  "updated_at": 1640995200
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Response

Successfully retrieved balance

Response body for getting account balance from the credit ledger.

​
object
enum<string>
required
Available options:
balances
Example:

"balances"

​
available_balance_cents
integer<u-int64>
required

Available balance in cents: sum(credit) - sum(debit) - sum(committed holds)

Required range: x >= 0
Example:

150000

​
current_balance_cents
integer<u-int64>
required

Reserved balance in cents: sum(credit) - sum(debit)

Required range: x >= 0
Example:

180000

​
current_overage_cents
integer<u-int64>
required

Total spend that hasn't been paid for yet, in cents.

Required range: x >= 0
Example:

0

​
overage_limit_cents
integer<u-int64>
required

The maximum amount of overages the account can incur before they are blocked from buying compute.

Required range: x >= 0
Example:

0

​
updated_at
integer<int64>
required

When the balance was last updated as a unix timestamp

Example:

1640995200