Skip to content

payment_stats

View payment statistics

Estimate_income

Path
GET /v7.0/payment_stat/estimate_income
Description
Estimate income for selected month and duration
Authentication required
yes
Scope
payment_stats#estimate_income
Aliases
Blocking
no

Input parameters

Layout
hash
Namespace
payment_stat
ParameterTypeRequiredDetails
year
Year
 Integer yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
month
Month
 Integer yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
select
Select
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Include

Allowed values:

  • exactly_until
  • all_until

Validation error message: %{value} cannot be used
duration
Duration
 Integer yes

Outage duration in minutes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
hash
Namespace
payment_stat
ParameterTypeDescription
user_count
User_count
 Integer
estimated_income
Estimated_income
 Integer