Skip to main content
GET
/
api
/
ApiBalance
/
GetApiBalance
Get API account balance
curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/ApiBalance/GetApiBalance \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'
{
  "totalNumberOfRecords": 123,
  "apiBalances": [
    {
      "apiBalanceId": 123,
      "currencyCode": "<string>",
      "balance": 123
    }
  ]
}
Returns the current API balance for your account, including remaining credit (in USD). Call this to check whether your account has enough balance to create labels or other paid operations before submitting them.

Authorizations

​
x-rr-apikey
string
header
required

Your API key

​
x-rr-apitoken
string
header
required

Your API token — keep this private

Response

Success

​
totalNumberOfRecords
integer<int32>

Total number of balance records

​
apiBalances
object[]

List of API balances