1. Interface Description
Interface request domain name: bill.api3.convergecloud.com.
This API is used to query the consumption trend of monthly bills.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-03-31 15:46:04.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeBillTrendByMonthGateway |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-10-25 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| PayerUin | Yes | No | Uint64 | The UIN of the user who are querying bill data. Example: 100004603015 |
| BeginTime | Yes | No | String | The start time. The value must be the start time of the month and must be in the same month as the value of the EndTime parameter. Example: 2018-09-01 00:00:00. Example: 2018-10-24 10:00:00 |
| EndTime | Yes | No | String | The end time. The value must be the end time of the month and must be in the same month as the value of the BeginTime parameter. Example: 2018-09-30 23:59:59. Example: 2018-10-24 10:00:00 |
| Conditions | No | No | Conditions | Only TimeRange is supported. Example:View |
| MemberUin | No | No | String | Member account UIN Example: 1000102441223 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Ready | Uint64 | Indicates whether data is ready. 0: not ready. 1: ready. Example: 1 |
| Detail | TrendByMonthDetail | The monthly payment summary details. Example:View |
| Stat | TrendByMonthStat | The average expense. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidVoucher | The voucher is not supported. |
| FailedOperation.NotAllowToRefund | The order is non-refundable. |
| FailedOperation.InvalidDeal | The order in the current state does not support this operation. Only unpaid orders can be paid. |
| FailedOperation.SummaryDataNotReady | Summarizing data. Please wait. |
| InvalidParameterValue | Parameter value error. |
| FailedOperation | Operation failed. |
| FailedOperation.BalanceInsufficient | Insufficient account balance. |
| UnauthorizedOperation.NotFinanceAuth | The account does not have the permission for payment. Payment failed. |
| FailedOperation.PaySuccDeliverFailed | Paid successfully, but shipment failed. Contact the cloud platform staff for handling. |
| FailedOperation.ConfirmBillCheckFail | Download the bill before you confirm. |
| FailedOperation.PayPriceError | Payment failed. Contact the cloud platform staff for handling. |
| InvalidParameter | Parameter error. |
| FailedOperation.AgentPayDealCannotDown | The specification of the agent payment device cannot be downgraded. |
| FailedOperation.DeviceHasExpired | The device is expired. |
| FailedOperation.NeedPayTogeter | You must pay for the items in the same order at the same time. |
| UnauthorizedOperation.NotCertification | The account has not completed identity verification. Payment failed. |