Tenant Cloud Management and Audit Metering Management Billing DescribeUserDebtBill

DescribeUserDebtBill

Last Updated At: 2026-08-02 00:05:56

1. Interface Description

Interface request domain name: bill.api3.convergecloud.com.

API for querying bills of postpaid orders.

Default interface request rate limit: 20 times per second.

Interface update time: 2019-12-27 11:42:10.

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: DescribeUserDebtBill
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.
AcctId Yes No String The unique identifier of the account.
Example: 1001
SubAcctid Yes No String The identifier of the credit-fixed sub-account. CREDIT_FIXED
Example: CREDIT_FIXED
Device Yes No Int64 The type of the device that sends the request. 0: PC. 1: mobile phone.
Example: 1
Ts Yes No Int64 The UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
Example: 1730702488
BeginMonth No No String The beginning month of the time range to query. The value must be in the yyyymm format.
Example: 201812
EndMonth No No String The end month of the time range to query. The value must be in the yyyymm format.
Example: 201812
DebtbillStatus No No Int64 The payment status of the bills that you want to query. Valid values: 1 and 2. 1: paid off. 2: unpaid.
Example: 201812
OverDue No No Int64 The overdue status of the bills that you want to query. Valid values: 1 and 2. 1: non-overdue. 2: overdue.
Example: 1
Limit No No Uint64 The number of entries to be returned on each page. The maximum value is 20.
Example: 20
Offset No No Uint64 The number of the page to be returned.
Example: 0
MemberUin No No String Member account UIN
Example: 1000102441223

3. Output Parameters

Parameter name Type Description
DebtBillSet Array of DebtBillListData The information about the bills.
Example:View
AllNum String The total number of bills.
Example: 1000
RetNum String The number of bills returned.
Example: 1000
Offset String The number of the page returned.
Example: 0
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
InvalidParameter Parameter error.
FailedOperation Operation failed.
FailedOperation.DebtBillNotExist The bill does not exist.
FailedOperation.AcctNotExist The account does not exist.