---
title: "Retrieve account balance"
method: POST
path: "/kvm/v2/get/account-balance"
---

# Retrieve account balance

`POST /kvm/v2/get/account-balance`

## Request

- Base URL: `https://order.edisglobal.com`
- URL: `https://order.edisglobal.com/kvm/v2/get/account-balance`
- Auth: none required
- TypeScript: <https://skmtc.dev/edisglobal/apis/edis-global-management-api/docs/kvm/v2/get/account-balance/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the current account credit balance for the authenticated WHMCS account, including the amount and currency.

## Request body `application/x-www-form-urlencoded`

- object
  - `email` string: Your WHMCS email address.
  - `pw` string: Your WHMCS password.

## Response `200`

Successful response

- object
  - `balance` object
    - `amount` string: Current account credit balance amount.
    - `currency` string: Currency of the account balance.
  - `status` string: Request status. Returns `success` when the request was processed correctly.

## Other responses

- `400`: Bad request - Invalid parameters
- `401`: Unauthorized - Invalid WHMCS credentials.
- `500`: Server error

---

[API](https://skmtc.dev/edisglobal/apis/edis-global-management-api.md) - [All operations](https://skmtc.dev/edisglobal/apis/edis-global-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edisglobal/apis/edis-global-management-api/revisions/223263c91ac0?raw)