v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

accountManagement

Get usage forecast with respect to last number of days specified.

Get usage forecast with respect to last number of days specified. If nothing is provided for last number of days, the average of term period will be taken to do the forecast.

get/v1/account/usageForecast

Query parameters

numberOfDaysnumber

Number of days to use for calculating average usage and forecast.

Response

Usage Forecast.

averageUsagenumber double

Average credit usage per day till now.

usagePercentagenumber double

Percentage of total credits used till date.

forecastedUsagenumber double

Total expected usage by the end of contract period.

forecastedUsagePercentagenumber double

Percentage of allocated credits that will be used in the contract period.

remainingDaysnumber double

Days remaining till all the credits are consumed.

Example response

{
  "averageUsage": 4,
  "usagePercentage": 7,
  "forecastedUsage": 10,
  "forecastedUsagePercentage": 5,
  "remainingDays": 10
}