> ## Documentation Index
> Fetch the complete documentation index at: https://docs.edisglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check the Account Balance

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



## OpenAPI

````yaml post /kvm/v2/get/account-balance
openapi: 3.0.0
info:
  title: EDIS Global ORDER API
  description: >
    Welcome to EDIS Global ORDER API 🚀

    The EDIS Global ORDER API allows seamless integration with our
    infrastructure to automate the entire product lifecycle (ordering and
    cancellations).


    Whether you’re integrating into your billing system or automating your
    service orders, our ORDER API makes managing the product lifecycle of EDIS
    Global services simple and effective. Below is a quick overview to help you
    get started.


    🚀 **Get Started Here**

    Follow these steps to begin using the EDIS Global ORDER API:


    - **Authentication:** Ensure you are authenticated (WHMCS username and
    password)

    - **Explore the Endpoints:** Use the endpoints below to order and cancel VPS
    services in any of our worldwide server locations.


    Available API Endpoints:


    **Payment Methods**

    - POST `get payment methods`
      Retrieve the available payment methods for your order.

    **Billing Cycles**

    - POST `get billingcycles`
      Get available billing cycles for different products.

    **Locations**

    - POST `get locations`
      Fetch all available VPS locations across the globe.

    **Products**

    - POST `get products`
      List the available VPS products and configurations.

    **Place an Order**

    - POST `add order`
      Add a new VPS order to the EDIS Global infrastructure.

    **Cancel a Product**

    - POST `cancel product`
      Cancel a specific product or VPS service.

    For more details on the EDIS Global ORDER API, please refer to the full
    documentation, and feel free to reach out if you have any questions or need
    assistance.


    Happy Coding!

    The EDIS Global Team
  version: 1.0.0
servers:
  - url: https://order.edisglobal.com
    description: Sandbox Server
security: []
paths:
  /kvm/v2/get/account-balance:
    servers:
      - url: https://order.edisglobal.com
        description: Production Server
    post:
      summary: Retrieve account balance
      description: >-
        Retrieves the current account credit balance for the authenticated WHMCS
        account, including the amount and currency.
      operationId: getAccountBalance
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: Your WHMCS email address.
                  example: yourwhmc_email
                pw:
                  type: string
                  description: Your WHMCS password.
                  example: yourwhmc_password
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  balance:
                    type: object
                    properties:
                      amount:
                        type: string
                        example: '20.00'
                        description: Current account credit balance amount.
                      currency:
                        type: string
                        example: EUR
                        description: Currency of the account balance.
                  status:
                    type: string
                    example: success
                    description: >-
                      Request status. Returns `success` when the request was
                      processed correctly.
              examples:
                successWithBalance:
                  summary: Account balance found
                  value:
                    balance:
                      amount: '20.00'
                      currency: EUR
                    status: success
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  errormsg:
                    type: string
                    example: Invalid parameters or missing fields.
        '401':
          description: Unauthorized - Invalid WHMCS credentials.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  errormsg:
                    type: string
                    example: Invalid WHMCS credentials.
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  errormsg:
                    type: string
                    example: Internal server error. Please try again later.

````