namecheap.users.getBalances

Gets information about fund in the user's account.This method returns the following information: Available Balance, Account Balance, Earned Amount, Withdrawable Amount and Funds Required for AutoRenew.

NOTE: If a domain setup with automatic renewal is expiring within the next 90 days, the "FundsRequiredForAutoRenew" attribute shows the amount needed in your NameCheap account to complete auto renewal.

Request Parameters

Global parameters are not shown here for clarity, but should be present in all requests

Name Type MaxLength Required? Default Description
None

Example Request

https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&
UserName=apiexample&Command=namecheap.users.getBalances&ClientIp=192.168.1.109

Example Response

<?xml version="1.0" encoding="utf-8"?>
<ApiResponse Status="OK">
  <Errors/>
  <RequestedCommand>namecheap.users.getBalances</RequestedCommand>
  <CommandResponse Type="namecheap.users.getBalances">
    <UserGetBalancesResult  
      Currency="USD" AvailableBalance="4932.96" AccountBalance="4932.96"
      EarnedAmount="381.70" WithdrawableAmount="1243.36"
      FundsRequiredForAutoRenew="0.00"/>
  </CommandResponse>
  <Server>SERVER-NAME</Server>
  <GMTTimeDifference>+5</GMTTimeDifference>
  <ExecutionTime>0.024</ExecutionTime>
</ApiResponse>

Error Codes

Specifies the error codes that might be returned from this method

Number Description
4022312 Balance information is not available

Comments

Support requests, bug reports, and off-topic comments will be deleted without warning.

Please do post corrections or additional information/ pointers for this article below. We aim to quickly move corrections into the documentation. Also, your comments may take some time to appear.

If you need specific help with your account, please contact Support

We are an ICANN accredited registrar. Serving customers since 2001
TRUSTe online privacy certification
Verisign Security Seal - Click to Verify
Payment Options
Supported Currency Conversions