Data Types

Last updated: 2025-08-01 10:47:16

Data Types

Last updated: 2025-08-01 10:47:16

ActionSummaryOverviewItem

Transaction type details in the customer bill data totaled by payment mode

Used by actions: DescribeBillSummaryByPayMode.

Name	Type	Description
ActionType	String	Transaction type code.
ActionTypeName	String	Transaction type name.
OriginalCost	String	Actual total consumption, up to 8 decimal places.
VoucherPayAmount	String	Voucher payment amount, up to 8 decimal places.
TotalCost	String	Total consumption, up to 8 decimal places.

BillDetailData

Customer bill details

Used by actions: DescribeCustomerBillDetail.

Name	Type	Description
PayerAccountId	Integer	reseller account.
OwnerAccountId	Integer	Subaccount.
OperatorAccountId	Integer	Operator account.
ProductName	String	Product name.
BillingMode	String	Billing mode . Monthly subscription (annual and monthly). Pay-As-You-Go resources. Standard ri reserved instance.
ProjectName	String	Project name.
Region	String	Resource region.
AvailabilityZone	String	Resource available zone.
InstanceId	String	Instance id.
InstanceName	String	Instance name.
SubProductName	String	Sub-Product name .
TransactionType	String	Settlement type.
TransactionId	String	.
TransactionTime	String	Settlement time.
UsageStartTime	String	.
UsageEndTime	String	.
ComponentType	String	Component.
ComponentName	String	Component name.
ComponentListPrice	String	Component list price.
ComponentPriceMeasurementUnit	String	Price unit.
ComponentUsage	String	Component usage.
ComponentUsageUnit	String	Component usage unit.
UsageDuration	String	Resource usage duration.
DurationUnit	String	duration unit.
OriginalCost	String	Total original price. Original cost = component list price * component usage * usage duration.
DiscountRate	String	Discount (default is 1) - abandoned.
Currency	String	Currency.
TotalAmountAfterDiscount	String	Total cost after discount.
VoucherDeduction	String	Voucher deduction amount.
TotalCost	String	= Total Amount After Discount - Voucher Deduction
Id	String	Identifier (id).
CustomerDiscountRate	String	customer discount rate. The discount rate applied to the reseller's customer, which set by reseller, default value equal to 1.

BusinessInfo

Product information

Used by actions: DescribeBillSummary.

Name	Type	Description
BusinessCodeName	String	Product name.
BusinessCode	String	Product code.
OriginalCost	String	Original price.
VoucherPayAmount	String	Voucher amount.
RICost	String	RI deduction.
TotalCost	String	Total amount.

BusinessSummaryOverviewItem

Product details in the customer bill data totaled by product

Used by actions: DescribeBillSummaryByProduct.

Name	Type	Description
BusinessCode	String	Product code.
BusinessCodeName	String	Product name.
OriginalCost	String	List price, keep 8 decimal places.
VoucherPayAmount	String	Voucher payment amount, keep 8 decimal places.
TotalCost	String	Consumption amount, keep 8 decimal places.

CountryCodeItem

Element type of the GetCountryCodes API

Used by actions: GetCountryCodes.

Name	Type	Description
EnName	String	Country/region name in English
Name	String	Country/region name in Chinese
IOS2	String
IOS3	String
Code	String	International dialing code

CustomerBillDetailData

Customer bill details

Used by actions: DescribeBillDetail.

Name	Type	Description
PayerAccountId	Integer	Distributor account.
OwnerAccountId	Integer	Sub-Customer account.
OperatorAccountId	Integer	Operator account.
ProductName	String	Product name.
BillingMode	String	Billing mode . Monthly subscription. Pay-As-You-Go resources. Standard ri reserved instances.
ProjectName	String	Project name. .
Region	String	Resource region.
AvailabilityZone	String	Resource availability zone.
InstanceId	String	Instance id.
InstanceName	String	Instance name.
SubProductName	String	Sub-Product name .
TransactionType	String	Settlement type.
TransactionId	String	Transaction flow id.
TransactionTime	String	Settlement time.
UsageStartTime	String	Resource start time.
UsageEndTime	String	Resource end time.
ComponentType	String	Component.
ComponentName	String	Component name.
ComponentListPrice	String	Component list price.
ComponentPriceMeasurementUnit	String	Price unit.
ComponentUsage	String	Component usage.
ComponentUsageUnit	String	Component usage unit.
UsageDuration	String	Resource usage duration.
DurationUnit	String	duration unit.
OriginalCost	String	Total original price. Original cost = component list price * component usage * usage duration.
Currency	String	Currency.
TotalCost	String	= Total Amount After Discount - Voucher Deduction
Id	String	Id identifier.
Tags	Array of TagInfo	Tag information.

DescribeCustomerInfoData

Customer information

Used by actions: DescribeCustomerInfo.

Name	Type	Description
CustomerUin	String	Sub-Account uin.
Email	String	Contact email.
Phone	String	Contact phone number.
Mark	String	Remarks.
Name	String	Display name.
BindTime	String	Binding time.
AccountStatus	String	Account status. 0: normal. 1: forcibly mandatory (this function is not supported yet). 2: mandatory arrears.
AuthStatus	String	Specifies the identity verification status. -999: account information not found. -1: file not uploaded. 0: pending review. Under review. Error in review: 2. 3: pass review.
AuthType	Integer	Real-Name type. -1: default value. no such information. 0: personal type. 1: enterprise type.
CidRegisterTime	String	Specifies the registration time of the cid.
UinRegisterTime	String	Specifies the registration time of the uin.
AuthPassTime	String	Time when real-name authentication passed.
HasExpense	Integer	Whether there is consumption. 0: no consumption; 1: consumption.

DescribeCustomerOwnVoucherItem

Voucher data.

Used by actions: DescribeCustomerOwnVoucherList.

Name	Type	Description
VoucherId	Integer	Voucher ID.
CustomerUin	Integer	Sub-account UIN
VoucherStatus	String	Voucher status: Issued/Used/Expired/Invalidated.
RemainingAmount	Float	Remaining amount.
TotalAmount	Float	Denomination.
PaymentMode	String	Payment mode. valid values: AllPayment, Prepaid, and Postpaid.
ProductScope	String	Applicable product: AllProducts/SpecifyProducts/SpecifyProductsBlacklist.
EffectiveTime	String	Start time.
ExpireTime	String	End time.

DescribeCustomerUinData

List of customer UINs

Used by actions: DescribeCustomerUin.

Name	Type	Description
CustomerUin	String	Customer UIN Note: This field may return null, indicating that no valid values can be obtained.

DescribeCustomerVoucherItem

Voucher data.

Used by actions: DescribeCustomerVoucherList.

Name	Type	Description
VoucherId	Integer	Voucher ID.
CustomerUin	Integer	Sub-account UIN
VoucherStatus	String	Voucher status: Issued/Used/Expired/Invalidated.
RemainingAmount	Float	Remaining amount.
TotalAmount	Float	Denomination.
Usage	String	Purpose: ProductTrial/CustomerOffer.
PaymentMode	String	Payment mode. valid values: AllPayment, Prepaid, and Postpaid.
ProductScope	String	Applicable product: AllProducts/SpecifyProducts/SpecifyProductsBlacklist.
EffectiveTime	String	Start time.
ExpireTime	String	End time.
ApplyReason	String	Application notes

PayModeSummaryOverviewItem

Payment mode details in the customer bill data totaled by payment mode

Used by actions: DescribeBillSummaryByPayMode.

Name	Type	Description
PayMode	String	Payment mode.
PayModeName	String	Payment mode name.
OriginalCost	String	Actual total consumption, up to 8 decimal places.
Detail	Array of ActionSummaryOverviewItem	Bill details in each payment mode.
VoucherPayAmount	String	Voucher payment amount, up to 8 decimal places.
TotalCost	String	Total consumption, up to 8 decimal places.

PolicyProductList

Policy product list entity response parameters structure.

Used by actions: QueryPolicyProductListByCode.

Name	Type	Description
PolicyCode	String	Policy code.
ProductCode	String	The code of the ProductName field in the bill data. If the return value is *, any item at this level is included in the policy product range.
ProductName	String	The ProductName field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
SubProductCode	String	The code of the SubProduct field in the bill data. If the return value is *, any item at this level is included in the policy product range.
SubProductName	String	The SubProduct field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
ComponentTypeCode	String	The code of the ComponentType field in the bill data. If the return value is *, any item at this level is included in the policy product range.
ComponentTypeName	String	The ComponentType field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
ComponentCode	String	The code of the Component field in the bill data. If the return value is *, any item at this level is included in the policy product range.
ComponentName	String	The Component field value in the billing data. If the return value is *, any item at this level is included in the policy product range.
StartDate	String	Policy effective time.
EndDate	String	Policy expiration time.

QueryCreditAllocationHistoryData

Returned information for querying the customer credit allocation records

Used by actions: QueryCreditAllocationHistory.

Name	Type	Description
AllocatedTime	String	Allocation time
Operator	String	Operator
Credit	Float	Allocated credit value
AllocatedCredit	Float	The allocated total credit
ClientCreditAfter	Float	Available credits after allocation.
Remark	String	Remark

QueryCustomerBillingQuotaData

Sub-customer credit balance data

Used by actions: QueryCustomerBillingQuota.

Name	Type	Description
TotalCredit	Float	Total credit limit (unit: usd), accurate down to two decimal places.
RemainingCredit	Float	Remaining credit limit (unit: usd), accurate down to two decimal places.
RemainingVoucher	Float	Remaining total voucher amount (unit: usd), accurate down to two decimal places.
Force	Integer	Forced status. Note: this field may return null, indicating that no valid values can be obtained.
PrepayFrozen	Float	Prepaid frozen amount.
PostpayFrozen	Float	Postpaid frozen amount.

QueryCustomersCreditData

Complex type of output parameters for querying customer's credit

Used by actions: QueryCustomersCredit.

Name	Type	Description
Name	String	Name
Type	String	Type
Mobile	String	Mobile number
Email	String	Email
Arrears	String	Overdue payment flag
AssociationTime	String	Binding time
RecentExpiry	String	Expiration time
ClientUin	Integer	Customer UIN
Credit	Float	Credit allocated to a customer
RemainingCredit	Float	The remaining credit of a customer
IdentifyType	Integer	`0`: Identity not verified; `1`: Individual identity verified; `2`: Enterprise identity verified.
Remark	String	Customer remarks
Force	Integer	Forced status

QueryDirectCustomersCreditData

The credit information of direct customers

Used by actions: QueryCreditByUinList, QueryDirectCustomersCredit.

Name	Type	Description
Uin	Integer	User UIN
TotalCredit	Float	Total credit
RemainingCredit	Float	Remaining credit

QueryInvitationInfoData

Invitation link information.

Used by actions: QueryInvitationInfo.

Name	Type	Required	Description
InvitationToken	String	No	Invitation link token.
CreateTime	String	No	Creation time of the invitation link.
Status	Integer	No	Invite link status. 1: Unused. 2: Used.
UseTime	String	No	Indicates the usage time of the invitation link.
ClientUin	Integer	No	Customer uin.
ClientMail	String	No	Customer mailbox.
ClientType	Integer	No	Customer type. 1: Second-Level reseller. 2: Sub-Customer.
BindTime	String	No	The binding time of the customer.

QueryPendingCustomersItem

Pending review sub-customer

Used by actions: QueryPendingClientsV2.

Name	Type	Description
ApplyTime	String	Application time.
ClientUin	Integer	Sub-Account uin.
Email	String	Email.
Mobile	String	Mobile number.
Name	String	Name.
Status	String	Approval status.
Type	String	Sub-Customer type.

QueryPendingSubAgentsV2ResponseData

Information of second-level reseller application in progress.

Used by actions: QueryPendingSubAgentsV2.

Name	Type	Description
SubAgentUin	Integer	Second-level reseller UIN.
Name	String	Name
Mobile	String	Mobile number.
Email	String	Specifies the mailbox.
ApplyTime	String	Application time
Status	String	Approval status {Reviewing: pending review}.
MaterialUrl	String	Application material.
AuthState	Integer	Identity verification status -1: file not uploaded 0: pending review 1: under review; 2: review error; 3: approved.

QuerySubAgentsDetailV2ResponseData

Second-Level reseller information.

Used by actions: QuerySubAgentsDetailV2.

Name	Type	Description
SubAgentUin	Integer	Second-level reseller UIN.
Name	String	Name
Remark	String	Remarks
Mobile	String	Mobile number.
Email	String	Specifies the mailbox.
CountOfCustomers	Integer	Number of secondary dealer sub-customers.
BindTime	String	Binding time.
Credit	Float	Credit limit pool of second-level reseller.
RemainingCredit	Float	Value pool of unconsumed credit limit for second-level reseller.
Voucher	Float	Cash coupon quota pool for second-level reseller.
RemainingVoucher	Float	Balance of cash coupon quota pool for second-level reseller.

QueryT1IndirectCustomersDetailResponseData

Query data of indirect sub-customers of a first-level distributor.

Callable roles: Distributor

Used by actions: QueryT1IndirectCustomersDetail.

Name	Type	Description
ClientUin	Integer	Customer uin.
ClientName	String	Customer name.
ClientBindTime	String	The time when a sub-customer binds a second-level reseller, time zone: UTC+08:00.

QueryVoucherAmountByUinItem

Customer voucher quota

Used by actions: QueryVoucherAmountByUin.

Name	Type	Description
ClientUin	Integer	Customer UIN
TotalAmount	Float	Voucher quota
RemainAmount	Float	Voucher amount

QueryVoucherListByUinItem

Voucher information of a single customer

Used by actions: QueryVoucherListByUin.

Name	Type	Description
ClientUin	Integer	Customer UIN
TotalCount	Integer	The total number of vouchers
Data	Array of QueryVoucherListByUinVoucherItem	Voucher details

QueryVoucherListByUinVoucherItem

Customer voucher information

Used by actions: QueryVoucherListByUin.

Name	Type	Description
VoucherId	String	Voucher ID
VoucherStatus	String	Voucher status
TotalAmount	Float	Voucher value
RemainAmount	Float	Balance

RegionSummaryOverviewItem

Region details in the customer bill data totaled by region

Used by actions: DescribeBillSummaryByRegion.

Name	Type	Description
RegionId	String	Region id.
RegionName	String	Region name.
OriginalCost	String	Actual total consumption, up to 8 decimal places.
VoucherPayAmount	String	Voucher payment amount, up to 8 decimal places.
TotalCost	String	Total consumption, up to 8 decimal places.

SummaryDetails

Detailed summary by billing dimension