Accounting section reference
This page provides technical information about the Accounting section included in the output of our APIs such as the Whois API and the authentication API.
Contents
Overview
The output of all of our APIs includes an Accounting section at the end that tells you how many service units your request cost, what your remaining balance is, and other summary information that’s useful for tracking your account usage.
Data model
-
QueryDate - Date of your request.
-
QueryCost - Total cost of processing your request in service units.
-
QueryCostDetails - Line items (like those on an invoice) for specific options or discounts that added up to the total cost of the query.
-
Username - Username of the user who issued the request.
-
UserIPAddress - IP address from which the request was sent.
-
CurrentBalance - Current balance of the user’s account in service units. This amount does not include charges for any authorized-but-still-pending requests.
-
AvailableBalance - Current account balance in service units minus any outstanding authorized amounts that have been reserved. This is the balance used to determine whether you have sufficient units left for another request.
-
BalanceAfterLastRefill - Account balance immediately after the previous refill (or initial setup).
-
LastRefillDate - Date of the previous refill (or initial setup).
-
EstimatedDepletionDate - Estimate of the date on which the account will run out of service units. This is based on the average usage rate since the last refill and is most accurate when your usage is relatively regular and uniform. This estimate may not be as useful if your service usage is highly irregular.
-
UsageRateSinceLastRefill - Average service usage rate since the last refill, expressed as service units per month. This is equal to (
BalanceAfterLastRefill-CurrentBalance) / Months( Now -LastRefillDate). -
NextRefillDate - Date of next scheduled, automatic account refill (if applicable).
Formats
All dates are expressed in Internet Date/Time Format, a profile of ISO 8601 format. All service unit amounts are decimal floating-point numbers.
For the Accounting section schema, see the specification for your chosen MIME type:
-
application/vnd.hexillion.auth-v2+xml - Version 2 XML format.
-
application/vnd.hexillion.auth-v2+json - Version 2 JSON format.