Get account balance

GET https://sms.8x8.com/api/v1/accounts/:accountId/balance
  • Sending a GET request on this endpoint allows to get account balance.

Note: this resource is available for prepaid customers only.

Request

Path Parameters

    accountId stringrequired

    Possible values: >= 32 characters and <= 36 characters, Value must match regular expression ^[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}$

    You must replace {accountId} with the accountid that you want to use.

Schema

    balancenumber

    Balance value

    currencystring

    Currency

{
"balance":0,
"currency":"string"
}
{
"balance":149309.7985931,
"currency":"USD"
}

Resource is available for prepaid customers only

Schema

{
"code":1201,
"message":"Account not in prepaid mode",
"errorId":"c388daa9-980e-eb11-81f8-0433c2195dfb",
"timestamp":"2020-10-15T03:44:02.25Z"
}
{
"code":1201,
"message":"Account not in prepaid mode",
"errorId":"c388daa9-980e-eb11-81f8-0433c2195dfb",
"timestamp":"2020-10-15T03:44:02.25Z"
}

Rate limiting quota exceeded error

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":429,
"message":"Quota exceeded. Please try again in 1 second(s).",
"errorId":"c8a41b47-57bf-ea11-8273-00155d466a31",
"timestamp":"2020-07-06T07:07:00.30Z"
}

Internal server error

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":2000,
"message":"Internal server error",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-07-02T09:42:38.8988997+00:00"
}

Source: https://developer.8x8.com/connect/reference/get-account-balance · 8x8 CPaaS Developer Docs. Synced for support deflection.

Was this article helpful?
or
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.

Didn't find what you were looking for?

Submit a request