tencent cloud

All product documents
International Partners
Data Types
Last updated: 2025-03-28 11:37:12
Data Types
Last updated: 2025-03-28 11:37:12

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).
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).

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 Identity verification status.
-1: files not uploaded.
0: not submitted for review.
1: under review.
2: review error.
3: approved.

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.

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.

QueryCustomerBillingQuotaData

Sub-customer credit balance data

Used by actions: QueryCustomerBillingQuota.

Name Type Description
TotalCredit Float Total credit limit (unit: cny), accurate down to two decimal places.
RemainingCredit Float Remaining credit limit (unit: cny), accurate down to two decimal places.
RemainingVoucher Float Remaining total voucher amount (unit: cny), 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.

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

Used by actions: DescribeBillSummary.

Name Type Description
Business Array of BusinessInfo Product information list.
OriginalCost String Original price.
VoucherPayAmount String Voucher amount.
RICost String RI deduction.
TotalCost String .
GroupKey String Classification dimension summary key.
GroupValue String Summary value by classification dimension.

TagInfo

Cost Allocation Tags

Used by actions: DescribeBillDetail.

Name Type Description
TagKey String Tag key.
TagValue String Tag value.

TradeOneNode

Primary Industry Information

Used by actions: GetTradeConfigList.

Name Type Description
Id String Layer-1 industry id.
Name String Layer-1 industry name.
Children Array of TradeTwoNode Layer-2 industries corresponding to the layer-1 industry.

TradeTwoNode

Secondary Industry Information

Used by actions: GetTradeConfigList.

Name Type Description
Id String Secondary industry id.
Name String Secondary industry name.
TradeInfo String Industry information.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon