tencent cloud

Data Types
Last updated: 2025-11-13 20:46:31
Data Types
Last updated: 2025-11-13 20:46:31

ActionSummaryOverviewItem

Detailed summary of costs by transaction type

Used by actions: DescribeBillSummaryByPayMode.

Name Type Description
ActionType String Transaction type code
ActionTypeName String Transaction type, which can be monthly subscription purchase, monthly subscription renewal, or pay-as-you-go deduction.
RealTotalCostRatio String Cost ratio, to two decimal points
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash account
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit. Note: This field may return null, indicating that no valid values can be obtained.
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.

AdjustInfoDetail

This API is used to view UIN exception adjustment details.

Used by actions: DescribeBillAdjustInfo.

Name Type Required Description
PayerUin String No Payer UIN, namely the account ID of the payer. The account ID is the user's unique account identifier on Tencent Cloud.
Note: This field may return null, indicating that no valid values can be obtained.
Example value: 909619400.
Month String No Bill month. Format: yyyy-MM.
Note: This field may return null, indicating that no valid value can be obtained.
Example value: 2024-10.
AdjustType String No Adjustment type.
Adjustment: manualAdjustment.
Supplementary settlement: supplementarySettlement.
Re-settlement: reSettlement.
Note: This field may return null, indicating that no valid value can be obtained.
Example value: manualAdjustment.
AdjustNum String No Adjustment order number.
Note: This field may return null, indicating that no valid value can be obtained.
Example value: 2220726096135.
AdjustCompletionTime String No Completion time of exception adjustment. Format: yyyy-MM-dd HH:mm:ss.
Note: This field may return null, indicating that no valid value can be obtained.
Example value: 2022-12-02 12:39:04.
AdjustAmount Float No Adjustment amount.
Note: This field may return null, indicating that no valid value can be obtained.
Example value: 333.00000000.

AllocationRationExpression

Expression for sharing proportion.

Used by actions: CreateAllocationRule, DescribeAllocationRuleDetail, ModifyAllocationRule.

Name Type Required Description
NodeId Integer Yes Cost allocation unit ID that the sharing rule belongs to.
Ratio Float Yes Sharing proportion occupied by allocation unit, pass 0 for allocation by proportion.

AllocationRuleExpression

Cost allocation regular expression.

Used by actions: CreateAllocationRule, CreateGatherRule, DescribeAllocationRuleDetail, DescribeGatherRuleDetail, ModifyAllocationRule, ModifyGatherRule.

Name Type Required Description
RuleKey String No RuleKey: cost allocation dimension.
Enumeration value.
ownerUin - user UIN.
Operator UIN.
businessCode - product-level code.
productCode - 2-tier product code.
itemCode - 4-tier product code.
projectId - specifies the project ID.
regionId.
resourceId - specifies the resource ID.
tag - tag key-value pair.
payMode - billing mode.
instanceType - instance type.
actionType - transaction type.
Operator String No Specifies the dimension rules for cost allocation.
Enumeration value.
in.
not in.
RuleValue Array of String No Cost allocation dimension value. for example, when RuleKey is businessCode, ["p_cbs","p_sqlserver"] indicates the cost of products at the "p_cbs","p_sqlserver" level.
Connectors String No Logical connection for cost allocation, enumeration values are as follows:.
Create and bind a policy query an instance reset the access password of an instance.
Create and bind a policy query an instance reset the access password of an instance.
Children Array of AllocationRuleExpression No Nested rule.

AllocationRuleOverview

Overview of sharing rules.

Used by actions: DescribeAllocationRuleSummary.

Name Type Description
RuleId Integer Sharing rule ID.
RuleName String Sharing rule name.
Type Integer Public area policy type.
Enumeration value.
1 - custom sharing proportion.
2 - proportional allocation.
3 - allocation by proportion.
UpdateTime String Last update time of the sharing rules.
AllocationNode Array of AllocationUnit Overview of cost allocation units.

AllocationRulesSummary

List of sharing rules.

Used by actions: CreateAllocationRule.

Name Type Required Description
Name String Yes Add new sharing rule name.
Type Integer Yes Specifies the sharing rule policy type. the enumeration values are as follows:.
1 - custom sharing proportion.
2 - proportional allocation.
3 - allocation by proportion.
RuleDetail AllocationRuleExpression Yes Sharing rule expression.
RatioDetail Array of AllocationRationExpression No Sharing proportion expression, allocation by proportion not passed.

AllocationTree

Cost allocation tree.

Used by actions: DescribeAllocationTree.

Name Type Description
Id Integer ID of a cost allocation unit.
Name String Cost allocation unit name.
TreeNodeUniqKey String Unique identifier of a cost allocation unit
Children Array of AllocationTree Subtree.

AllocationUnit

Specifies the ID and name of a cost allocation unit.

Used by actions: DescribeAllocationRuleSummary.

Name Type Description
NodeId Integer Cost allocation unit ID.
TreeNodeUniqKeyName String Specifies the name of a cost allocation rule.

AnalyseActionTypeDetail

Cost analysis transaction type complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
ActionType String No Transaction type codeNote: This field may return null, indicating that no valid values can be obtained.
ActionTypeName String No Transaction type nameNote: This field may return null, indicating that no valid values can be obtained.

AnalyseAmountDetail

Cost analysis amount return data model

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
Key String No Fee typeNote: This field may return null, indicating that no valid values can be obtained.
Display Integer No Whether to displayNote: This field may return null, indicating that no valid values can be obtained.

AnalyseBusinessDetail

Cost analysis product return complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
BusinessCode String Product codeNote: This field may return null, indicating that no valid values can be obtained.
BusinessCodeName String Product nameNote: This field may return null, indicating that no valid values can be obtained.

AnalyseConditionDetail

Cost analysis filter box complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
Business Array of AnalyseBusinessDetail ProductNote: This field may return null, indicating that no valid values can be obtained.
Project Array of AnalyseProjectDetail ItemNote: This field may return null, indicating that no valid values can be obtained.
Region Array of AnalyseRegionDetail RegionNote: This field may return null, indicating that no valid values can be obtained.
PayMode Array of AnalysePayModeDetail Billing modeNote: This field may return null, indicating that no valid values can be obtained.
ActionType Array of AnalyseActionTypeDetail Transaction typeNote: This field may return null, indicating that no valid values can be obtained.
Zone Array of AnalyseZoneDetail Availability zoneNote: This field may return null, indicating that no valid values can be obtained.
OwnerUin Array of AnalyseOwnerUinDetail Resource owner UINNote: This field may return null, indicating that no valid values can be obtained.
Amount Array of AnalyseAmountDetail Fee typeNote: This field may return null, indicating that no valid values can be obtained.

AnalyseConditions

Cost analysis query conditions

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
BusinessCodes String No Product name codeNote: This field may return null, indicating that no valid values can be obtained.
ProductCodes String No Sub-product name codeNote: This field may return null, indicating that no valid values can be obtained.
ComponentCode String No Component type codeNote: This field may return null, indicating that no valid values can be obtained.
ZoneIds String No Availability zone ID: The availability zone ID to which the resource belongsNote: This field may return null, indicating that no valid values can be obtained.
RegionIds String No Region ID: The region ID to which the resource belongsNote: This field may return null, indicating that no valid values can be obtained.
ProjectIds String No Project ID: The project ID to which the resource belongsNote: This field may return null, indicating that no valid values can be obtained.
PayModes String No Billing mode prePay (indicates monthly subscription)/postPay (indicates pay-as-you-go billing)Note: This field may return null, indicating that no valid values can be obtained.
ActionTypes String No Transaction type. Query transaction type. (Use transaction type code input parameter.)Note: This field may return null, indicating that no valid values can be obtained.
Tags String No Cost allocation tag keyNote: This field may return null, indicating that no valid values can be obtained.
FeeType String No Fee type. Query fee type. (Use fee type code input parameter.) The input parameter enumeration is as follows:cashPayAmount: cash incentivePayAmount: free credits voucherPayAmount: coupons tax:taxes costBeforeTax: price before taxNote: This field may return null, indicating that no valid values can be obtained.
PayerUins String No User UIN for querying cost analysis dataNote: This field may return null, indicating that no valid values can be obtained.
OwnerUins String No User UIN for using resourcesNote: This field may return null, indicating that no valid values can be obtained.
ConsumptionTypes String No Consumption type. Query consumption type. (Use consumption type code input parameter.)Note: This field may return null, indicating that no valid values can be obtained.

AnalyseDetail

Cost analysis data complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
Name String Time
Total String Amount
TimeDetail Array of AnalyseTimeDetail Date detailed amountNote: This field may return null, indicating that no valid values can be obtained.

AnalyseHeaderDetail

Cost analysis header data complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
HeadDetail Array of AnalyseHeaderTimeDetail Header dateNote: This field may return null, indicating that no valid values can be obtained.
Name String TimeNote: This field may return null, indicating that no valid values can be obtained.
Total String TotalNote: This field may return null, indicating that no valid values can be obtained.

AnalyseHeaderTimeDetail

Cost analysis header data

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
Name String No DateNote: This field may return null, indicating that no valid values can be obtained.

AnalyseOwnerUinDetail

Cost analysis user UIN complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
OwnerUin String No User UIN
Note: This field may return null, indicating that no valid values can be obtained.

AnalysePayModeDetail

Cost analysis payment method complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
PayMode String No Billing mode codeNote: This field may return null, indicating that no valid values can be obtained.
PayModeName String No Billing mode nameNote: This field may return null, indicating that no valid values can be obtained.

AnalyseProjectDetail

Cost analysis project return complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
ProjectId String No Project ID
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String No Default projectNote: This field may return null, indicating that no valid values can be obtained.

AnalyseRegionDetail

Cost analysis region return complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
RegionId String No Region ID
Note: This field may return null, indicating that no valid values can be obtained.
RegionName String No Region nameNote: This field may return null, indicating that no valid values can be obtained.

AnalyseTimeDetail

Cost analysis return value complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
Time String DateNote: This field may return null, indicating that no valid values can be obtained.
Money String AmountNote: This field may return null, indicating that no valid values can be obtained.

AnalyseZoneDetail

Cost analysis availability zone complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
ZoneId String No Availability zone IDNote: This field may return null, indicating that no valid values can be obtained.
ZoneName String No Availability zone nameNote: This field may return null, indicating that no valid values can be obtained.

ApplicableProducts

The products that are applicable.

Used by actions: DescribeVoucherInfo.

Name Type Description
GoodsName String Valid values: all products or names of the applicable products (string). Multiple names are separated by commas.
PayMode String Valid values: postPay: pay-as-you-go; prePay: prepaid; riPay: reserved instance; empty or *: all. If GoodsName contains multiple product names and PayMode is *, it indicates that the voucher can be used in all billing modes for each of the products.

BillDetail

Bill details

Used by actions: DescribeBillDetail.

Name Type Description
BusinessCodeName String Product name: The name of a Tencent Cloud product purchased by the user, such as CVM.
ProductCodeName String Subproduct name: The subcategory of a Tencent Cloud product purchased by the user, such as CVM Standard S1.
PayModeName String Billing mode, which can be monthly subscription or pay-as-you-go.
ProjectName String Project name: The project to which a resource belongs, which is user-designated. If a resource has not been assigned to a project, it will automatically belong to the default project.
RegionName String Region: The region to which a resource belongs, such as South China (Guangzhou).
ZoneName String Availability zone: availability zone of a resource, e.g. Guangzhou Zone 3
ResourceId String Instance ID: The object ID of a billed resource, such as a CVM instance ID. This object ID may vary due to various forms and contents of resources in different products.
ResourceName String Instance name: The resource name set by the user in the console. If it is not set, it will be empty by default.
ActionTypeName String Transaction type, which can be monthly subscription purchase, monthly subscription renewal, or pay-as-you-go deduction.
OrderId String Order ID: The order number for a monthly subscription purchase
BillId String Transaction ID: The bill number for a deducted payment
PayTime Timestamp Transaction time: The time at which a payment was deducted
FeeBeginTime Timestamp Usage start time: The time at which product or service usage starts
FeeEndTime Timestamp Usage end time: The time at which product or service usage ends
ComponentSet Array of BillDetailComponent Component list
PayerUin String Payer account ID: The account ID of the payer, which is the unique identifier of a Tencent Cloud user.
OwnerUin String Owner account ID: The account ID of the actual resource user
OperateUin String Operator account ID: The account or role ID of the operator who purchases or activates a resource
Tags Array of BillTagInfo Tag information. Note: This field may return null, indicating that no valid values can be obtained.
BusinessCode String Product code. Note: This field may return null, indicating that no valid values can be obtained.
ProductCode String Subproduct code. Note: This field may return null, indicating that no valid values can be obtained.
ActionType String Transaction type code. Note: This field may return null, indicating that no valid values can be obtained.
RegionId String Region ID. Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID
PriceInfo Array of String Price attribute: A set of attributes which will determine the price of a component, apart from unit price and usage duration.
Note: This field may return null, indicating that no valid values can be obtained.
AssociatedOrder BillDetailAssociatedOrder Associated transaction document ID: The ID of the document associated with a transaction, such as a write-off order, the original order showing a deduction error during first settlement, a restructured order, or the original purchase order corresponding to a refund order.
Note: This field may return null, indicating that no valid values can be obtained.
Formula String Calculation formula: The detailed calculation formula for a specific transaction type, such as refund or configuration change.
Note: This field may return null, indicating that no valid values can be obtained.
FormulaUrl String Billing rules: Official website links for detailed billing rules of each product.
Note: This field may return null, indicating that no valid values can be obtained.
BillDay String Billing dayNote: This field may return null, indicating that no valid values can be obtained.
BillMonth String Billing monthNote: This field may return null, indicating that no valid values can be obtained.
Id String Billing record IDNote: This field may return null, indicating that no valid values can be obtained.
RegionType String Domestic and international codesNote: This field may return null, indicating that no valid values can be obtained.
RegionTypeName String Domestic and International: The region type to which the resource belongs (domestic, international)Note: This field may return null, indicating that no valid values can be obtained.
ReserveDetail String Note attributes (instance configuration): Other note information, such as the reserved instance, the reserved instance type, the transaction type, and the region information on both ends of the CCN product.Note: This field may return null, indicating that no valid values can be obtained.
DiscountObject String the discount object for the current consumption item, such as official website discount, user discount, and event discount.
DiscountType String the discount type for the current consumption item, such as discount and contract price.
DiscountContent String supplementary description of the discount type, such as 0.2.

BillDetailAssociatedOrder

Information of the document associated with bill details

Used by actions: DescribeBillDetail, DescribeBillDetailForOrganization.

Name Type Description
PrepayPurchase String Purchase order.
Note: This field may return null, indicating that no valid values can be obtained.
PrepayRenew String Renewal order.
Note: This field may return null, indicating that no valid values can be obtained.
PrepayModifyUp String Upgrade order.
Note: This field may return null, indicating that no valid values can be obtained.
ReverseOrder String Write-off order.
Note: This field may return null, indicating that no valid values can be obtained.
NewOrder String The order after discount.
Note: This field may return null, indicating that no valid values can be obtained.
Original String The original order before discount.
Note: This field may return null, indicating that no valid values can be obtained.

BillDetailComponent

Information about components charged in the bill

Used by actions: DescribeBillDetail, DescribeBillDetailForOrganization.

Name Type Description
ComponentCodeName String Component type: The component type of a product or service purchased, such as CVM instance components including CPU and memory.
ItemCodeName String Component name: The specific component of a product or service purchased
SinglePrice String Component list price: The listed unit price of a component. If a customer has applied for a fixed preferential price or contract price, this parameter will not be displayed by default.
PriceUnit String Component price measurement unit: The unit of measurement for a component price, which is composed of USD, usage unit, and duration unit.
UsedAmount String Component usage: The actually settled usage of a component, which is "Raw usage - Deducted usage (including packages)".
UsedAmountUnit String Component usage unit: The unit of measurement for component usage
RealTotalMeasure String Raw usage/duration: The raw usage/duration of a component before deduction. Note: This field may return null, indicating that no valid values can be obtained.
DeductedMeasure String Deducted usage/duration (including packages): The usage/duration deducted with a package. Note: This field may return null, indicating that no valid values can be obtained.
TimeSpan String Usage duration: The resource usage duration
TimeUnitName String Duration unit: The unit of measurement for usage duration
Cost String Original cost: The original cost of a resource, which is "List price x Usage x Usage duration". If a customer has applied for a fixed preferential price or contract price or is in a refund scenario, this parameter will not be displayed by default.
Discount String Discount multiplier: The discount multiplier applied to the cost of the resource. If a customer has applied for a fixed preferential price or contract price or is in a refund scenario, this parameter will not be displayed by default.
ReduceType String Offer type
RealCost String Total amount after discount: Total amount after discount = (Original cost - RI deduction (cost) - SP deduction (cost)) x Discount multiplier
VoucherPayAmount String Voucher payment: The voucher deduction amount
CashPayAmount String Cash credit: The amount paid from the user's cash account
IncentivePayAmount String Free credit: The amount paid with the user's free credit
TransferPayAmount String Commission credit: The amount paid with the user's commission credit. Note: This field may return null, indicating that no valid values can be obtained.
ItemCode String Component type code. Note: This field may return null, indicating that no valid values can be obtained.
ComponentCode String Component name code. Note: This field may return null, indicating that no valid values can be obtained.
ContractPrice String Component contracted price: The contracted unit price of a component, which is "List price x Discount". Note: This field may return null, indicating that no valid values can be obtained.
InstanceType String Instance type: The instance type of a product or service purchased, which can be resource package, RI, SP, or spot instance. Other instance types are not displayed by default. Note: This field may return null, indicating that no valid values can be obtained.
RiTimeSpan String RI deduction (duration): The usage duration deducted by RI. Note: This field may return null, indicating that no valid values can be obtained.
OriginalCostWithRI String RI deduction (cost): The amount deducted from the original cost by RI. Note: This field may return null, indicating that no valid values can be obtained.
SPDeductionRate String Savings plan deduction rate: The discount multiplier that applies to the component based on the remaining commitment of the savings plan. Note: This field may return null, indicating that no valid values can be obtained.
OriginalCostWithSP String SP deduction (cost): SP deduction (cost) = Cost deduction by SP / SP deduction rate. Note: This field may return null, indicating that no valid values can be obtained.
BlendedDiscount String Blended discount multiplier: The final discount multiplier that is applied after combining multiple discount types, which is "Total amount after discount / Original cost". Note: This field may return null, indicating that no valid values can be obtained.
ComponentConfig Array of BillDetailComponentConfig Configuration description: The specification configuration of an instance.
Note: This field may return null, indicating that no valid values can be obtained.
TaxRate String The tax rate.
TaxAmount String The tax amount.
Currency String The currency used for the settlement of a component.

BillDetailComponentConfig

Bill details configuration descriptions

Used by actions: DescribeBillDetail, DescribeBillDetailForOrganization.

Name Type Description
Name String Configuration description name
Note: This field may return null, indicating that no valid values can be obtained.
Value String Configuration description value
Note: This field may return null, indicating that no valid values can be obtained.

BillDistributionResourceSummary

Summary objects for a reseller bill

Used by actions: DescribeBillResourceSummaryForOrganization.

Name Type Description
BusinessCodeName String Product name: The name of a Tencent Cloud product purchased by the user, such as CVM.
ProductCodeName String Subproduct name: The subcategory of a Tencent Cloud product purchased by the user, such as CVM - Standard S1.
PayModeName String Billing mode: The billing mode, which can be monthly subscription or pay-as-you-go.
ProjectName String Project Name: The project to which a resource belongs, which is user-designated. If a resource has not been assigned to a project, it will automatically belong to the default project.
RegionName String Region: The region of a resource, e.g. South China (Guangzhou).
ZoneName String Availability zone: The availability zone of a resource, e.g. Guangzhou Zone 3.
ResourceId String Instance ID: The object ID of a billed resource, such as a CVM instance ID. This object ID may vary due to various forms and contents of resources in different products.
ResourceName String Instance name: The resource name set by the user in the console. If it is not set, it will be empty by default.
ActionTypeName String Transaction type, which can be monthly subscription purchase, monthly subscription renewal, pay-as-you-go deduction, etc.
OrderId String Order ID: The ID of a monthly subscription order.
PayTime Timestamp Deduction time: The settlement cost deduction time.
FeeBeginTime Timestamp Usage start time: The time at which product or service usage starts.
FeeEndTime Timestamp Usage end time: The time at which product or service usage ends.
ConfigDesc String Configuration description: The billable item names and usage of a resource, which are displayed on the resource bill only.
ExtendField1 String Extended Field 1: The extended attribute information of a product, which is displayed on the resource bill only.
ExtendField2 String Extended field 2: The extended attribute information of a product, which is displayed on the resource bill only.
TotalCost String Original cost. The original cost of a component = Component price x Usage x Usage duration. If a customer has applied for a fixed preferential price or contract price or if a customer is in a refund scenario, this parameter will not be displayed by default.
Discount String Discount multiplier: The discount multiplier that applies to the component. If a customer has applied for a fixed preferential price or contract price or if a customer is in a refund scenario, this parameter will not be displayed by default.
ReduceType String Offer type.
RealTotalCost String Total amount after discount.
VoucherPayAmount String Voucher payment: The voucher deduction amount.
CashPayAmount String Cash credit payment: The amount paid through the user's cash account.
IncentivePayAmount String Free credit payment: The amount paid with the user's free credit.
TransferPayAmount String Commission credit payment: The amount paid with the user's commission credit.
Note: This field may return null, indicating that no valid values can be obtained.
ExtendField3 String Extended field 3: The extended attribute information of a product, which is displayed on the resource bill only.
ExtendField4 String Extended field 4: The extended attribute information of a product, which is displayed on the resource bill only.
ExtendField5 String Extended field 5: The extended attribute information of a product, which is displayed on the resource bill only.
Tags Array of BillTagInfo Tag information.
Note: This field may return null, indicating that no valid values can be obtained.
OwnerUin String Owner account ID: The account ID of the actual resource user.
OperateUin String Operator account ID: The account or role ID of the operator who purchases or activates a resource.
BusinessCode String Product code.
ProductCode String Subproduct code.
RegionId Integer Region ID.
InstanceType String Instance type: The instance type of a product or service purchased, which can be resource package, RI, SP, or spot instance. Other instance types are not displayed by default.
OriginalCostWithRI String RI deduction (cost): The amount deducted from the original cost by RI.
OriginalCostWithSP String SP deduction (cost): The amount of cost deducted by a savings plan based on the component's original cost. SP deduction (cost) = Cost deduction by SP / SP deduction rate
BillMonth String Billing monthNote: This field may return null, indicating that no valid values can be obtained.

BillResourceSummary

Information about resources charged in the bill

Used by actions: DescribeBillResourceSummary.

Name Type Description
BusinessCodeName String Product name: The name of a Tencent Cloud product purchased by the user, such as CVM.
ProductCodeName String Subproduct name: The subcategory of a Tencent Cloud product purchased by the user, such as CVM Computing C5t.
PayModeName String Billing mode, which can be monthly subscription or pay-as-you-go.
ProjectName String Project name: The project to which a resource belongs, which is user-designated. If a resource has not been assigned to a project, it will automatically belong to the default project.
RegionName String Region: The region to which a resource belongs, such as South China (Guangzhou).
ZoneName String Availability zone: The availability zone to which a resource belongs, such as Guangzhou Zone 3.
ResourceId String Instance ID: The object ID of a billed resource, such as a CVM instance ID. This object ID may vary due to various forms and contents of resources in different products.
ResourceName String Instance name: The resource name set by the user in the console. If it is not set, it will be empty by default.
ActionTypeName String Transaction type, which can be monthly subscription purchase, monthly subscription renewal, or pay-as-you-go deduction.
OrderId String Order ID: The order number for a monthly subscription purchase
PayTime Timestamp Transaction time: The time at which a payment was deducted
FeeBeginTime Timestamp Usage start time: The time at which product or service usage starts
FeeEndTime Timestamp Usage end time: The time at which product or service usage ends
ConfigDesc String Configuration description: The billable item names and usage of a resource, which are displayed on the resource bill only.
ExtendField1 String Extended field 1: Extended attribute information of a product, which is displayed on the resource bill only.
ExtendField2 String Extended field 2: Extended attribute information of a product, which is displayed on the resource bill only.
TotalCost String Original cost: The original cost of a resource, which is "List price x Usage x Usage duration". If a customer has applied for a fixed preferential price or contract price or applied for a refund, this parameter will not be displayed by default.
Discount String Discount multiplier: The discount multiplier applied to the cost of the resource. If a customer has applied for a fixed preferential price or contract price or applied for a refund, this parameter will not be displayed by default.
ReduceType String Offer type
RealTotalCost String Total amount after discount (Including Tax): = Total Amount After Discount (Excluding Tax) + TaxAmount
VoucherPayAmount String Voucher payment: The voucher deduction amount
CashPayAmount String Cash credit: The amount paid from the user's cash account
IncentivePayAmount String Free credit: The amount paid with the user's free credit
TransferPayAmount String Commission credit: The amount paid with the user's commission credit. Note: This field may return null, indicating that no valid values can be obtained.
ExtendField3 String Extended field 3: Extended attribute information of a product, which is displayed on the resource bill only.
ExtendField4 String Extended field 4: Extended attribute information of a product, which is displayed on the resource bill only.
ExtendField5 String Extended field 5: Extended attribute information of a product, which is displayed on the resource bill only.
Tags Array of BillTagInfo Tag information. Note: This field may return null, indicating that no valid values can be obtained.
PayerUin String Payer account ID: The account ID of the payer, which is the unique identifier of a Tencent Cloud user.
OwnerUin String Owner account ID: The account ID of the actual resource user
OperateUin String Operator account ID: The account or role ID of the operator who purchases or activates a resource.
BusinessCode String Product code
ProductCode String Subproduct code
RegionId Integer Region ID
InstanceType String Instance type: The instance type of a product or service purchased, which can be resource package, RI, SP, or spot instance. Other instance types are not displayed by default.
OriginalCostWithRI String RI deduction (cost): The amount deducted from the original cost by RI
OriginalCostWithSP String SP deduction (cost): SP deduction (cost) = Cost deduction by SP / SP deduction rate
BillMonth String Billing monthNote: This field may return null, indicating that no valid values can be obtained.

BillTagInfo

Bill tag information.

Used by actions: DescribeBillDetail, DescribeBillDetailForOrganization, DescribeBillResourceSummary, DescribeBillResourceSummaryForOrganization.

Name Type Description
TagKey String Cost allocation tag key
TagValue String Tag value

BusinessSummaryInfo

Detailed summary of products

Used by actions: DescribeBillSummary, DescribeBillSummaryForOrganization.

Name Type Description
BusinessCode String Product code
BusinessCodeName String Product name: The name of a Tencent Cloud product purchased by the user, such as CVM.
TotalCost String Original cost in USD. This parameter became valid when Bill 3.0 took effect in May 2021. Before that, - was returned for this parameter. If a customer has applied for a contract price different from the prices listed on the official website, - will also be returned for this parameter.
Note: This field may return null, indicating that no valid values can be obtained.
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash account
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit. Note: This field may return null, indicating that no valid values can be obtained.

BusinessSummaryOverviewItem

Summarize product details by product

Used by actions: DescribeBillSummaryByProduct.

Name Type Description
BusinessCode String Product code. Note: This field may return null, indicating that no valid values can be obtained.
BusinessCodeName String Product name: The name of a Tencent Cloud product purchased by the user, such as CVM.
RealTotalCostRatio String Cost ratio, to two decimal points
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash account
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit.
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.

BusinessSummaryTotal

Summarize total cost by product

Used by actions: DescribeBillSummaryByProduct.

Name Type Description
RealTotalCost String Total amount after discount
VoucherPayAmount String Voucher payment: The voucher deduction amount
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
CashPayAmount String Cash credit: The amount paid from the user’s cash account
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit.
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.

ConditionBusiness

Product filter criteria

Used by actions: DescribeCostSummaryByResource.

Name Type Description
BusinessCode String Product name code
BusinessCodeName String Product name

ConditionPayMode

Payment mode filter criteria

Used by actions: DescribeCostSummaryByResource.

Name Type Description
PayMode String Payment mode
PayModeName String Payment mode name

ConditionProject

Project filter criteria

Used by actions: DescribeCostSummaryByResource.

Name Type Description
ProjectId String Project ID
ProjectName String Project name

ConditionRegion

Regional filter criteria

Used by actions: DescribeCostSummaryByResource.

Name Type Description
RegionId String Region ID
RegionName String Region name

Conditions

Billing filter criteria object

Used by actions: DescribeCostSummaryByResource.

Name Type Required Description
TimeRange Integer No Only supports two values: 6 and 12.
BusinessCode String No Product name code
ProjectId Integer No Project ID
RegionId Integer No Region ID
PayMode String No Payment mode. Options include prePay and postPay.
ResourceKeyword String No Resource keyword
BusinessCodes Array of String No Product name code
ProductCodes Array of String No Subproduct name code
RegionIds Array of Integer No Region ID
ProjectIds Array of Integer No Project ID
PayModes Array of String No Payment mode. Options include prePay and postPay.
ActionTypes Array of String No Transaction type
HideFreeCost Integer No Whether to hide zero-amount transactions
OrderByCost String No Sorting rule. Options include desc and asc.
BillIds Array of String No Transaction ID
ComponentCodes Array of String No Component code
FileIds Array of String No File ID
FileTypes Array of String No File type
Status Array of Integer No Status

ConsumptionBusinessSummaryDataItem

Consumption details summarized by product

Used by actions: DescribeCostSummaryByProduct, DescribeCostSummaryByProject, DescribeCostSummaryByRegion.

Name Type Description
BusinessCode String Product name code
BusinessCodeName String Product name
RealTotalCost String Discounted total price
Trend ConsumptionSummaryTrend Cost trend
CashPayAmount String Cash
Note: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Bonus
Note: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String VoucherNote: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Share revenueNote: This field may return null, indicating that no valid values can be obtained.
RegionName String Region name (only shown in regional summary)
Note: This field may return null, indicating that no valid values can be obtained.

ConsumptionProjectSummaryDataItem

Consumption details summarized by project

Used by actions: DescribeCostSummaryByProject.

Name Type Description
ProjectId String Project ID
ProjectName String Project name
RealTotalCost String Discounted total price
Trend ConsumptionSummaryTrend Trend
Business Array of ConsumptionBusinessSummaryDataItem Product consumption details
CashPayAmount String Cash
Note: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Bonus
Note: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String VoucherNote: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Share revenueNote: This field may return null, indicating that no valid values can be obtained.

ConsumptionRegionSummaryDataItem

Consumption details summarized by region

Used by actions: DescribeCostSummaryByRegion.

Name Type Description
RegionId String Region ID
RegionName String Region name
RealTotalCost String Discounted total price
Trend ConsumptionSummaryTrend Trend
Business Array of ConsumptionBusinessSummaryDataItem Product consumption details
CashPayAmount String Cash
Note: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String VoucherNote: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Bonus
Note: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Share revenueNote: This field may return null, indicating that no valid values can be obtained.

ConsumptionResourceSummaryConditionValue

Filter criteria of consumption details summarized by resource

Used by actions: DescribeCostSummaryByResource.

Name Type Description
Business Array of ConditionBusiness Product list
Project Array of ConditionProject Project list
Region Array of ConditionRegion Region list
PayMode Array of ConditionPayMode Payment mode list

ConsumptionResourceSummaryDataItem

Consumption details summarized by resource

Used by actions: DescribeCostSummaryByResource.

Name Type Description
ResourceId String Resource ID
ResourceName String Resource name
RealTotalCost String Discounted total price
CashPayAmount String Cash expenditure
ProjectId String Project ID
ProjectName String Project name
RegionId String Region ID
RegionName String Region name
PayMode String Payment mode
PayModeName String Payment mode name
BusinessCode String Product name code
BusinessCodeName String Product name
ConsumptionTypeName String Consumption type
RealCost String Pre-discount priceNote: This field may return null, indicating that no valid values can be obtained.
FeeBeginTime String Start time of feesNote: This field may return null, indicating that no valid values can be obtained.
FeeEndTime String End time of feesNote: This field may return null, indicating that no valid values can be obtained.
DayDiff String Days
Note: This field may return null, indicating that no valid values can be obtained.
DailyTotalCost String Daily consumptionNote: This field may return null, indicating that no valid values can be obtained.
OrderId String Order numberNote: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String VoucherNote: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Bonus
Note: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Share revenueNote: This field may return null, indicating that no valid values can be obtained.
PayerUin String Payer UIN: the account ID of the payer, which is the unique identifier of a Tencent Cloud userNote: This field may return null, indicating that no valid values can be obtained.
OwnerUin String User UIN: the account ID of the actual resource userNote: This field may return null, indicating that no valid values can be obtained.
OperateUin String Operator UIN: the account ID or role ID of the operator who places orders for prepaid resources or activates postpaid resourcesNote: This field may return null, indicating that no valid values can be obtained.
ProductCode String Subproduct codeNote: This field may return null, indicating that no valid values can be obtained.
ProductCodeName String Subproduct name: the subcategory of a product purchased by the user, such as CVM – Standard S1Note: This field may return null, indicating that no valid values can be obtained.
RegionType String Region typeNote: This field may return null, indicating that no valid values can be obtained.
RegionTypeName String Region type nameNote: This field may return null, indicating that no valid values can be obtained.
Extend1 String Extended field 1Note: This field may return null, indicating that no valid values can be obtained.
Extend2 String Extended field 2Note: This field may return null, indicating that no valid values can be obtained.
Extend3 String Extended field 3Note: This field may return null, indicating that no valid values can be obtained.
Extend4 String Extended field 4Note: This field may return null, indicating that no valid values can be obtained.
Extend5 String Extended field 5Note: This field may return null, indicating that no valid values can be obtained.
InstanceType String Instance typeNote: This field may return null, indicating that no valid values can be obtained.
InstanceTypeName String Instance type nameNote: This field may return null, indicating that no valid values can be obtained.
PayTime String Deduction time: the time at which a payment is deductedNote: This field may return null, indicating that no valid values can be obtained.
ZoneName String Availability zone: availability zone of a resource, e.g. Guangzhou Zone 3Note: This field may return null, indicating that no valid values can be obtained.
ComponentConfig String Configuration descriptionNote: This field may return null, indicating that no valid values can be obtained.
Tags String Tag information.Note: This field may return null, indicating that no valid values can be obtained.

ConsumptionSummaryTotal

Consumption summary details

Used by actions: DescribeCostSummaryByProduct, DescribeCostSummaryByProject, DescribeCostSummaryByRegion, DescribeCostSummaryByResource.

Name Type Description
RealTotalCost String Discounted total price

ConsumptionSummaryTrend

Consumption cost trend

Used by actions: DescribeCostSummaryByProduct, DescribeCostSummaryByProject, DescribeCostSummaryByRegion.

Name Type Description
Type String Trend type, upward for rising, downward for falling, none for no change
Value String Trend value. The value is null when Type is none.Note: This field may return null, indicating that no valid values can be obtained.

CosDetailSets

Information about the data structure of the returned COS usage details

Used by actions: DescribeDosageCosDetailByDate.

Name Type Description
BucketName String Bucket name
DosageBeginTime String The start time of the usage
DosageEndTime String The end time of the usage
SubProductCodeName String Subproduct name
BillingItemCodeName String Billable item name
DosageValue String Usage
Unit String Unit of the billable item

CostComponentSet

Consumption component details

Used by actions: DescribeCostDetail.

Name Type Description
ComponentCodeName String Component type name
ItemCodeName String Component name
SinglePrice String List price
PriceUnit String List price unit
UsedAmount String Usage
UsedAmountUnit String Usage unit
Cost String Original price
Discount String Discount
RealCost String Discounted price
VoucherPayAmount String Voucher payment amount
CashPayAmount String Cash payment amount
IncentivePayAmount String Bonus payment amount

CostDetail

Consumption details data type

Used by actions: DescribeCostDetail.

Name Type Description
PayerUin String Payer UIN
BusinessCodeName String Product name
ProductCodeName String Subproduct name
PayModeName String Billing mode name
ProjectName String Project name
RegionName String Region Name
ZoneName String Zone name
ResourceId String Resource ID
ResourceName String Resource name
ActionTypeName String Type nameNote: This field may return null, indicating that no valid values can be obtained.
OrderId String Order ID
BillId String Transaction ID
FeeBeginTime String Start time of fees
FeeEndTime String End time of fees
ComponentSet Array of CostComponentSet Component details
ProductCode String Subproduct name code

Deal

Order data object

Used by actions: DescribeDealsByCond.

Name Type Description
OrderId String Order ID.
Status Integer The status of the order. 1: unpaid; 2: paid; 3: shipping; 4: shipped; 5: shipment failed; 6: refunded; 7: closed case; 8: order expired; 9: order invalidated; 10: product invalidated; 11: third-party payment refused; 12: payment in process
Payer String Payer
CreateTime Timestamp Creation time
Creator String Creator
RealTotalCost Integer Actual payment amount (pent)
VoucherDecline Integer Voucher offset amount (pent)
ProjectId Integer Project ID
GoodsCategoryId Integer Product category ID
ProductInfo Array of ProductInfo Product details
TimeSpan Float Duration
TimeUnit String Time unit
Currency String Currency unit
Policy Float Discount rate
Price Float Unit price (cents)
TotalCost Float Original price (cents)
ProductCode String Product code
SubProductCode String Subproduct code
BigDealId String Large order number.
Formula String Refund formula.
RefReturnDeals String Refund involves order information.
PayMode String Billing mode: prePay (prepaid), postPay (pay-as-you-go), riPay (reserved instance)
Action String Transaction type

Modify network mode adjust bandwidth mode.
Adjust bandwidth size.
Refund: refund.
downgrade.
upgrade configuration.
renew.
purchase.
preMoveOut monthly subscription resource migration out.
preMoveIn specifies the monthly subscription resources to migrate.
preToPost specifies the prepaid to postpaid conversion.
postMoveOut specifies the pay-as-you-go resources to be migrated out.
postMoveIn specifies the pay-as-you-go resources for inbound migration.
ProductName String Product code chinese name.
SubProductName String Sub-Product code chinese name.
ResourceId Array of String The resource ID corresponding to the order. If the query parameter Limit exceeds 200, null will be returned.
Note: This field may return null, indicating that no valid values can be obtained.

DistributionBillDetail

Objects of reseller bill details

Used by actions: DescribeBillDetailForOrganization.

Name Type Description
BusinessCodeName String Product name: The name of a Tencent Cloud product purchased by the user, such as CVM.
ProductCodeName String Subproduct name: The subcategory of a Tencent Cloud product purchased by the user, such as CVM - Standard S1.
PayModeName String Billing mode: The billing mode, which can be monthly subscription or pay-as-you-go.
ProjectName String Project Name: The project to which a resource belongs, which is user-designated. If a resource has not been assigned to a project, it will automatically belong to the default project.
RegionName String Region: The region of a resource, e.g. South China (Guangzhou).
ZoneName String Availability zone: availability zone of a resource, e.g. Guangzhou Zone 3.
ResourceId String Instance ID: The object ID of a billed resource, such as a CVM instance ID. This object ID may vary due to various forms and contents of resources in different products.
ResourceName String Instance name: The resource name set by the user in the console. If it is not set, it will be empty by default.
ActionTypeName String Transaction type, which can be monthly subscription purchase, monthly subscription renewal, pay-as-you-go deduction, etc.
OrderId String Order ID: The ID of a monthly subscription order.
BillId String Transaction ID: The ID of a settlement bill.
PayTime Timestamp Deduction time: The settlement cost deduction time.
FeeBeginTime Timestamp Usage start time: The time at which product or service usage starts.
FeeEndTime Timestamp Usage end time: The time at which product or service usage ends.
ComponentSet Array of BillDetailComponent List of components.
OwnerUin String Owner account ID: The account ID of the actual resource user.
OperateUin String Operator account ID: The account or role ID of the operator who purchases or activates a resource.
Tags Array of BillTagInfo Tag information.
Note: This field may return null, indicating that no valid values can be obtained.
BusinessCode String Product code.
Note: This field may return null, indicating that no valid values can be obtained.
ProductCode String Subproduct code.
Note: This field may return null, indicating that no valid values can be obtained.
ActionType String Transaction type code.
Note: This field may return null, indicating that no valid values can be obtained.
RegionId String Region ID.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID.
PriceInfo Array of String Price attribute: A set of attributes which will determine the price of a component, apart from unit price and usage duration.
Note: This field may return null, indicating that no valid values can be obtained.
AssociatedOrder BillDetailAssociatedOrder Associated transaction document ID: The ID of the document associated with a transaction, such as a write-off order, the original order showing a deduction error during first settlement, a restructured order, or the original purchase order corresponding to a refund order.
Note: This field may return null, indicating that no valid values can be obtained.
Formula String Calculation formula: The detailed calculation formula for a specific transaction type, such as refund or configuration change.
Note: This field may return null, indicating that no valid values can be obtained.
FormulaUrl String Billing rules: Official website links for detailed billing rules of each product.
Note: This field may return null, indicating that no valid values can be obtained.
BillMonth String Billing monthNote: This field may return null, indicating that no valid values can be obtained.
BillDay String Billing dayNote: This field may return null, indicating that no valid values can be obtained.

ExcludedProducts

The products that are not applicable.

Used by actions: DescribeVoucherInfo.

Name Type Description
GoodsName String The names of non-applicable products.
PayMode String postPay: pay-as-you-go; prePay: prepaid; riPay: reserved instance; empty or *: all.

GatherRuleSummary

List of collection rules.

Used by actions: CreateGatherRule.

Name Type Required Description
RuleDetail AllocationRuleExpression Yes Cost allocation regular expression.

PayModeSummaryOverviewItem

Detailed summary of costs by billing mode

Used by actions: DescribeBillSummaryByPayMode.

Name Type Description
PayMode String Billing mode code
PayModeName String Billing mode, which can be monthly subscription or pay-as-you-go.
RealTotalCostRatio String Cost ratio, to two decimal points
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash balance
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit.
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
Detail Array of ActionSummaryOverviewItem Detailed summary of costs by transaction type

ProductInfo

Product details

Used by actions: DescribeDealsByCond.

Name Type Required Description
Name String Yes Product detail name identifier
Value String Yes Product details

ProjectSummaryOverviewItem

Detailed summary of purchases by project

Used by actions: DescribeBillSummaryByProject.

Name Type Description
ProjectId String Project ID
ProjectName String Project name: The project to which a resource belongs, which is user-designated. If a resource has not been assigned to a project, it will automatically belong to the default project.
RealTotalCostRatio String Cost ratio, to two decimal points
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash account
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit.
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.

RegionSummaryOverviewItem

Detailed summary of purchases by region

Used by actions: DescribeBillSummaryByRegion.

Name Type Description
RegionId String Region ID
Note: This field may return null, indicating that no valid value was found.
RegionName String Region: The region to which a resource belongs, such as South China (Guangzhou).
RealTotalCostRatio String Cost ratio, to two decimal points
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash account
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit.
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.

SummaryDetail

Detailed summary of costs by multiple dimensions

Used by actions: DescribeBillSummary, DescribeBillSummaryForOrganization.

Name Type Description
GroupKey String Bill dimension code. Note: This field may return null, indicating that no valid values can be obtained.
GroupValue String Bill dimension value. Note: This field may return null, indicating that no valid values can be obtained.
TotalCost String Original cost in USD. This parameter has become valid since Bill 3.0 took effect in May 2021, and before that - was returned for this parameter. If a customer has applied for a contract price different from the prices listed on the official website, - will also be returned for this parameter.
RealTotalCost String Total amount after discount
CashPayAmount String Cash credit: The amount paid from the user’s cash account
IncentivePayAmount String Free credit: The amount paid with the user’s free credit
VoucherPayAmount String Voucher payment: The voucher deduction amount
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit. Note: This field may return null, indicating that no valid values can be obtained.
Business Array of BusinessSummaryInfo Detailed summary of products. Note: This field may return null, indicating that no valid values can be obtained.

SummaryTotal

Total cost

Used by actions: DescribeBillSummaryByTag.

Name Type Description
RealTotalCost String Total amount after discount. Note: This field may return null, indicating that no valid values can be obtained.
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
Note: this field may return null, indicating that no valid values can be obtained.

TagDataInfo

Tag information.

Used by actions: DescribeTagList.

Name Type Description
TagKey String Cost allocation tag key.
Status Integer Tag type. Valid values: 0 (general tags), 1 (cost allocation tags).
UpdateTime String Time to set the cost allocation tag. It will not be returned if Status is 0.
Note: This field may return null, indicating that no valid values can be obtained.

TagSummaryOverviewItem

Details about cost distribution over different tags.

Used by actions: DescribeBillSummaryByTag.

Name Type Description
TagValue String Tag value
Note: This field may return null, indicating that no valid values can be obtained.
RealTotalCostRatio String Cost percentage rounded to two decimal places
Note: This field may return null, indicating that no valid values can be obtained.
RealTotalCost String Total amount after discount. Note: This field may return null, indicating that no valid values can be obtained.
CashPayAmount String Cash credit: The amount paid from the user’s cash account. Note: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Free credit: The amount paid with the user’s free credit. Note: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String Voucher payment: The amount deducted by using vouchers. Note: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Commission credit: The amount paid with the user’s commission credit. Note: This field may return null, indicating that no valid values can be obtained.
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
Note: this field may return null, indicating that no valid values can be obtained.

UsageDetails

The product purchased.

Used by actions: DescribeVoucherUsageDetails.

Name Type Description
ProductName String The name of the product.
Note: This field may return null, indicating that no valid value was found.
SubProductName String

UsageRecords

The usage records.

Used by actions: DescribeVoucherUsageDetails.

Name Type Description
UsedAmount Integer The amount used. The value of this parameter is the amount used (USD, rounded to 8 decimal places) multiplied by 100,000,000.
UsedTime String The time when the voucher was used.
UsageDetails Array of UsageDetails The details of the product purchased.
Note: This field may return null, indicating that no valid value was found.

VoucherInfos

Voucher information.

Used by actions: DescribeVoucherInfo.

Name Type Description
OwnerUin String The owner of the voucher.
Status String The status of the voucher: unUsed, used, delivered, cancel, overdue
NominalValue Integer The value of the voucher. The value of this parameter is the voucher value (USD, rounded to 8 decimal places) multiplied by 100,000,000.
Balance Integer The balance left. The value of this parameter is the balance left (USD, rounded to 8 decimal places) multiplied by 100,000,000.
VoucherId String The voucher ID.
PayMode String postPay: pay-as-you-go; prePay: prepaid; riPay: reserved instance; empty or *: all.
PayScene String If PayMode is postPay, this parameter may be spotpay (spot instance) or settle account (regular pay-as-you-go). If PayMode is prePay, this parameter may be purchase, renew, or modify (downgrade/upgrade). If PayMode is riPay, this parameter may be oneOffFee (prepayment of reserved instance) or hourlyFee (hourly billing of reserved instance). * means to query vouchers that support all billing scenarios.
BeginTime String The start time of the validity period.
EndTime String The end time of the validity period.
ApplicableProducts ApplicableProducts The products that are applicable.
Note: This field may return null, indicating that no valid value was found.
ExcludedProducts Array of ExcludedProducts The products that are not applicable.
Note: This field may return null, indicating that no valid value was found.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback