tencent cloud

Billing Center

DocumentationBilling CenterAPI DocumentationData Types

Data Types

PDF
Focus Mode
Font Size
Last updated: 2026-04-24 15:08:40

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 yearly/monthly subscription purchase, yearly/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 Royalty account expenditure: The amount paid through the royalty account
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

Abnormal adjustment details of UIN

Used by actions: DescribeBillAdjustInfo.

Name Type Required Description
PayerUin String No Payer UIN: Account ID of the payer, which is the unique account identifier for the user in Tencent Cloud.
Month String No Bill month, formatted as yyyy-MM.
AdjustType String No Adjustment type
Bill adjustment: manualAdjustment
Supplementary settlement: supplementarySettlement
Re-settlement
AdjustNum String No Adjustment Number
AdjustCompletionTime String No Abnormal adjustment completion time. Format: yyyy-MM-dd HH:mm:ss
AdjustAmount Float No Adjustment Amount

AllocationAverageData

Average value for the trend graph of a cost allocation bill

Used by actions: DescribeAllocationTrendByMonth.

Name Type Description
BeginMonth String Start month
EndMonth String End month.
RealTotalCost String Average value of total fees (discounted total)

AllocationBillTrendDetail

Detail data of cost allocation trend chart

Used by actions: DescribeAllocationTrendByMonth.

Name Type Description
Month String Bill month
Name String Displayed name of bill month
RealTotalCost String Total fees (discounted total): Total fees of the cost allocation unit, Collected Fees (discounted total) + Allocated Fees (discounted total)

AllocationDetail

Details of a cost allocation bill

Used by actions: DescribeAllocationBillDetail.

Name Type Description
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit
BillDate String Date: Settlement date
PayerUin String Payer UIN: Account ID of the payer, which is the unique account identifier for the user in Tencent Cloud.
OwnerUin String User UIN: Account ID of the actual resource user
OperateUin String Operator account ID (the resource account ID or role ID opened by prepaid resource ordering or postpaid operation)
BusinessCode String Product code
BusinessCodeName String Product name: Various cloud products purchased by users
PayMode String Billing mode code
PayModeName String Billing mode: Resource billing mode, which can be monthly subscription or pay-as-you-go.
ProjectId Integer Project ID
ProjectName String Project name: The Project to which a resource belongs, which is independently allocated by the user for the resource in the console. If a resource has not been allocated to an Project, it will be a default Project.
RegionId Integer Region ID
RegionName String Region name: The region where the resource is located
ZoneId Integer AZ ID
ZoneName String Availability zone: The availability zone where the resource is located.
ResourceId String Resource ID: Resources vary by product, and the content is not identical. For example, Cloud Virtual Machine (CVM) corresponds to the instance ID. If the product is split, it shows the split item ID, such as COS bucket ID and CDN domain name.
ResourceName String Instance name: The name set by the user for the resource in the console, which is empty by default if not set. If the product is split, it shows the split resource alias.
InstanceType String Instance type code
InstanceTypeName String Instance type: The type of an instance corresponding to the product service purchased, including resource packages, RI, SP, and spot instances. It is displayed as "-" by default for regular instances.
ProductCode String Subproduct code
ProductCodeName String Subproduct name: Product subdivision type purchased by the user
ActionType String Transaction type code
ActionTypeName String Transaction type: Detailed transaction type
OrderId String Order ID: The order number for purchase in the annual and monthly billing mode
BillId String Transaction ID: The settlement and deduction number
PayTime String Deduction time: Deduction time
FeeBeginTime String Usage start time: Usage start time
FeeEndTime String Usage end time: Product or service usage end time
ComponentCode String Component type code
ComponentCodeName String Component type: The major component category corresponding to the product or service purchased by the user
SinglePrice String Component list price: The original unit price of the component on the portal (not displayed if the customer enjoys a fixed price/contract price)
ContractPrice String Component unit price: Discounted unit price of the component. Component unit price = list price * discount.
SinglePriceUnit String Component Price Unit: Unit of component price, Unit Composition: CNY/usage unit/duration unit
UsedAmount String Component usage: The actual settlement usage of the component, Component Usage = Original Component Usage - Deducted Usage (including resource packages)
UsedAmountUnit String Component usage unit: Unit of measurement corresponding to component usage.
TimeSpan String Usage duration: The duration of resource usage, Component Usage = Original Component Usage Duration - Deducted Duration (including resource packages)
TimeUnit String Duration unit: Unit of resource usage duration.
ReserveDetail String Remark attribute (instance configuration): Additional remark information, such as reserved instance type and transaction type for reserved instances, regional information of both ends for CCN products.
SplitRatio String Split item usage/duration ratio: Split item usage (duration) ratio, Split Item Usage (Duration) /Total Usage Before Splitting (Duration)
TotalCost String Original price of a component: Original Price = Component List Price * Component Usage * Duration of Use (not displayed if the customer enjoys a fixed price/contract price, and not displayed by default in refund scenarios), specified price mode
RITimeSpan String Reserved instance deduction duration: The duration of use deducted by reserved instances for this product or service.
RICost String Original price deducted by a reserved instance: The original price of a component deducted by reserved instances for this product or service
SPCost String Savings plan deduction from original price: Savings Plan Deduction from Original Price = Monetary Value of Savings Plan Deduction/ Savings Plan Deduction Rate
Discount String Discount rate: The discount rate enjoyed by this resource (it is not shown by default if the customer enjoys a fixed/contract price, and it is also not shown by default in the refund scenario)
BlendedDiscount String Mixed discount rate: The final discount rate after integrating various discount deductions. Mixed Discount Rate = Discounted total price/Original Price.
RealTotalCost String Discounted total: discounted total = (Original Price - Original Price Deducted by a Reserved Instance - Savings Plan Deduction from Original Price) * Discount Rate
CashPayAmount String Cash account expenditure (CNY): The amount paid through the cash account
VoucherPayAmount String Promo voucher expenditure (CNY): The amount paid using various vouchers (such as promo vouchers and cash vouchers)
IncentivePayAmount String Gift account expenditure (CNY): The amount paid using free credits
TransferPayAmount String Royalty account expenditure (CNY): The amount paid through the royalty account
Tag Array of BillTag Allocation tag: The resource-bound tag
RegionType String Domestic and international codes
RegionTypeName String Domestic and international: Resource region type (domestic, international)
ItemCode String Component name code
ItemCodeName String Component name: The specific component of a product or service purchased by the user
AssociatedOrder String Associated document ID: Document ID associated with this transaction, such as the original new purchase order corresponding to a refund order
PriceInfo Array of String Price attribute: Other attributes of the component that affect discount pricing besides unit price and duration
Formula String Calculation rule explanation: A detailed explanation to calculations of billing settlement for special transaction types, such as refund and configuration changes.
FormulaUrl String Billing Rules: The detailed billing rules for each product shown in the portal explanation link
RealTotalMeasure String Original usage/duration: The original usage of the component before deduction by resource packages.
(Currently only TRTC, TEM, Cloud Call Center, and CDZ products support this information display. Other products are being integrated.)
DeductedMeasure String Deduction of usage/duration (including resource packages): The amount of usage deducted by resource packages
(Currently only TRTC, TEM, Cloud Call Center, and CDZ products support this information display. Other products are being integrated.)
ComponentConfig String Configuration description: Information on specification of resource configuration
AllocationType Integer Cost collection type: The source types of fees, including allocated, collection and unallocated.
0 - Allocation
1 - Collection
2 - Unallocated
CostBeforeTax String CostBeforeTax
Tax String Tax
AmountBeforeTax String AmountBeforeTax
DiscountObject String Discount object of the current consumption item, such as official website discount, user discount and activity discount.
DiscountType String Discount type of the current consumption item, such as discount and contract price.
DiscountContent String Supplementary description of the offer type, for example: business discount 20% off, the offer type is "discount" and the discount content is "0.8".
SPDeduction String SPDeduction
SPDeductionRate String SPDeduction
Currency String Currency
BillMonth String Billing month
TaxRate String tax rate

AllocationMonthOverviewDetail

Monthly overview amount details of a cost allocation bill

Used by actions: DescribeAllocationMonthOverview.

Name Type Description
GatherCashPayAmount String Collected fees (cash): Cash directly collected to the cost allocation unit based on the collection rules
GatherVoucherPayAmount String Collected fees (voucher): Resource vouchers directly collected to the cost allocation unit based on the collection rules
GatherIncentivePayAmount String Collected fees (free credit): Resource free credit directly collected to the cost allocation unit based on the collection rules
GatherTransferPayAmount String Collected fees (royalty amount): Resource royalty amount directly collected to the cost allocation unit based on the collection rules
AllocateCashPayAmount String Allocated fees (cash): Resource cash allocated to the cost allocation unit based on the allocation rules
AllocateVoucherPayAmount String Allocated fees (vouchers): Resource vouchers allocated to the cost allocation unit based on the allocation rules
AllocateIncentivePayAmount String Allocated fees (free credit): Resource free credit allocated to the cost allocation unit based on the allocation rules
AllocateTransferPayAmount String Allocated fees (royalty amount): Resource royalty amount allocated to the cost allocation unit based on the allocation rules
TotalCashPayAmount String Total fees (cash): Total fees of the cost allocation unit, Collected Fees (Cash) + Allocated fees (Cash)
TotalVoucherPayAmount String Total fees (voucher): Total fees of the cost allocation unit, Collected Fees (Voucher) + Allocated fees (Voucher)
TotalIncentivePayAmount String Total fees (free credit): Total fees of the cost allocation unit, Collected Fees (Free Credit) + Allocated fees (Free Credit)
TotalTransferPayAmount String Total fees (royalty amount): Total cost of the cost allocation unit, Collected Fees (Royalty Amount) + Allocated fees (Royalty Amount)
GatherRealCost String Collected fees (discounted total): Total resource amount after discount directly collected to the cost allocation unit based on the collection rules
AllocateRealCost String Allocated fees (discounted total): Total resource amount after discount directly allocated to the cost allocation unit based on the allocation rules
RealTotalCost String Total fees (discounted total): Total fees of the cost allocation unit, Collected Fees (discounted total) + Allocated fees (discounted total)
Ratio String Proportion (discounted total): Total fees (discounted total) of the Cost Allocation Unit/Total Fees (discounted total) * 100%
Trend String Month-on-month ratio (discounted total): [Total fees (discounted total) of the cost allocation unit in this month - Total fees (discounted total) of the cost allocation unit in the previous month]/Total fees (discounted total) of the cost allocation unit in the previous month * 100%
TrendType String Sequential Comparison Arrow
upward - Upward
downward - Downward
none - Stable
AllocateCostBeforeTax String AllocateCostBeforeTax
GatherCostBeforeTax String GatherCostBeforeTax
TotalCostBeforeTax String TotalCostBeforeTax
AllocateTax String AllocateTax
GatherTax String GatherTax
TotalTax String TotalTax

AllocationOverviewDetail

Details of the cost allocation overview

Used by actions: DescribeAllocationOverview.

Name Type Description
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit
BillDate String Date: Settlement date
GatherCashPayAmount String Collected fees (cash): Cash directly collected to the cost allocation unit based on the collection rules
GatherVoucherPayAmount String Collected fees (voucher): Resource vouchers directly collected to the cost allocation unit based on the collection rules
GatherIncentivePayAmount String Collected fees (free credit): Resource free credit directly collected to the cost allocation unit based on the collection rules
GatherTransferPayAmount String Collected fees (royalty amount): Resource royalty amount directly collected to the cost allocation unit based on the collection rules
AllocateCashPayAmount String Allocated fees (cash): Resource cash allocated to the cost allocation unit based on the allocation rules
AllocateVoucherPayAmount String Allocated fees (voucher): Resource vouchers allocated to the cost allocation unit based on the allocation rules
AllocateIncentivePayAmount String Allocated fees (free credit): Resource free credit allocated to the cost allocation unit based on the allocation rules
AllocateTransferPayAmount String Allocated fees (royalty amount): Resource royalty amount allocated to the cost allocation unit based on the allocation rules
TotalCashPayAmount String Total fees (cash): Total fees of the cost allocation unit, Collected Fees (Cash) + Allocated Fees (Cash)
TotalVoucherPayAmount String Total fees (voucher): Total fees of the cost allocation unit, Collected Fees (Voucher) + Allocated Fees (Voucher)
TotalIncentivePayAmount String Total fees (free credit): Total fees of the cost allocation unit, Collected Fees (Free Credit) + Allocated Fees (Free Credit)
TotalTransferPayAmount String Total fees (royalty amount): Total fees of the cost allocation unit, Collected Fees (Royalty Amount) + Allocated Fees (Royalty Amount)
GatherRealCost String Collected fees (discounted total): Total resource amount after discount directly collected to the cost allocation unit based on the collection rules
AllocateRealCost String Allocated fees (discounted total): Total resource amount after discount directly allocated to the cost allocation unit based on the allocation rules
RealTotalCost String Total fees (discounted total): Total fees of the cost allocation unit, Collected Fees (discounted total) + Allocated Fees (discounted total)
Ratio String Proportion (discounted total): Total fees (discounted total) of the Cost Allocation Unit/Total Fees (discounted total) * 100%
Trend String Month-on-month ratio (discounted total): [Total fees (discounted total) of the cost allocation unit in this month - Total fees (discounted total) of the cost allocation unit in the previous month]/Total fees (discounted total) of the cost allocation unit in the previous month * 100%
TrendType String Sequential Comparison Arrow
upward - Upward
downward - Downward
none - Stable
GatherCostBeforeTax String GatherCostBeforeTax
AllocateCostBeforeTax String AllocateCostBeforeTax
TotalCostBeforeTax String TotalCostBeforeTax
GatherTax String GatherTax
AllocateTax String AllocateTax
TotalTax String TotalTax

AllocationOverviewNode

Monthly overview of a cost allocation bill

Used by actions: DescribeAllocationMonthOverview.

Name Type Description
Id Integer Cost allocation unit ID
Name String Name of a cost allocation unit
TreeNodeUniqKey String Unique identifier of a cost allocation unit
Symbol Integer Billing unit including a rule flag
0 - No rule exists.
1 - Both collection rules and allocation rules exist.
2 - Only collection rules exist.
3 - Only allocation rules exist.
Children Array of AllocationOverviewNode Detailed monthly overview of a sub-unit
Detail AllocationMonthOverviewDetail Monthly overview amount details of a cost allocation bill

AllocationOverviewTotal

Total amount of a cost allocation bill

Used by actions: DescribeAllocationBillDetail, DescribeAllocationMonthOverview, DescribeAllocationOverview, DescribeAllocationSummaryByBusiness, DescribeAllocationSummaryByItem, DescribeAllocationSummaryByResource.

Name Type Description
RealTotalCost String Total fees: Total Fees (Cash) + Total Fees (Royalty Amount) + Total Fees (Free Credit) + Total Fees (Voucher)
Note: This field may return null, indicating that no valid values can be obtained.
CashPayAmount String Cash: Total fees of cash
Note: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Free credit: Total fees of free credit
Note: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String Voucher: Total fees of voucher
Note: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Royalty amount: Total fees of royalty amount
Note: This field may return null, indicating that no valid values can be obtained.
CostBeforeTax String Pre-tax price after discount
Tax String Tax

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.

AllocationRule

Information on allocation rules hit by the current resource

Used by actions: DescribeGatherResource.

Name Type Required Description
RuleId Integer No Allocation rule ID
RuleName String No Allocation rule name

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.

AllocationStat

Trend graph of a cost allocation bill

Used by actions: DescribeAllocationTrendByMonth.

Name Type Description
Average AllocationAverageData Average cost information

AllocationSummaryByBusiness

Detailed summary of the cost allocation bill by business

Used by actions: DescribeAllocationSummaryByBusiness.

Name Type Description
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit
BillDate String Date: Settlement date
GatherCashPayAmount String Collected fees (cash): Cash directly collected to the cost allocation unit based on the collection rules
GatherVoucherPayAmount String Collected fees (voucher): Resource vouchers directly collected to the cost allocation unit based on the collection rules
GatherIncentivePayAmount String Collected fees (free credit): Resource free credit directly collected to the cost allocation unit based on the collection rules
GatherTransferPayAmount String Collected fees (royalty amount): Resource royalty amount directly collected to the cost allocation unit based on the collection rules
AllocateCashPayAmount String Allocated fees (cash): Resource cash allocated to the cost allocation unit based on the allocation rules
AllocateVoucherPayAmount String Allocated fees (voucher): Resource vouchers allocated to the cost allocation unit based on the allocation rules
AllocateIncentivePayAmount String Allocated fees (free credit): Resource free credit allocated to the cost allocation unit based on the allocation rules
AllocateTransferPayAmount String Allocated fees (royalty amount): Resource royalty amount allocated to the cost allocation unit based on the allocation rules
TotalCashPayAmount String Total fees (cash): Total fees of the cost allocation unit, Collected Fees (Cash) + Allocated fees (Cash)
TotalVoucherPayAmount String Total fees (voucher): Total fees of the cost allocation unit, Collected Fees (Vouchers) + Allocated fees (Vouchers)
TotalIncentivePayAmount String Total fees (free credit): Total fees of the cost allocation unit, Collected Fees (Free Credit) + Allocated fees (Free Credit)
TotalTransferPayAmount String Total fees (royalty amount): Total fees of the cost allocation unit, Collected Fees (Royalty Amount) + Allocated fees (Royalty Amount)
GatherRealCost String Collected fees (discounted total): Total resource amount after discount directly collected to the cost allocation unit based on the collection rules
AllocateRealCost String Allocated fees (discounted total): Total resource amount after discount allocated to the cost allocation unit based on the allocation rules
RealTotalCost String Total fees (discounted total): Total fees of the cost allocation unit, Collected Fees (discounted total) + Allocated fees (discounted total)
Ratio String Proportion (discounted total): Total fees (discounted total) of the Cost Allocation Unit/Total Fees (discounted total) * 100%
Trend String Month-on-month ratio (discounted total): [Total fees (discounted total) of the cost allocation unit in this month - Total fees (discounted total) of the cost allocation unit in the previous month]/Total fees (discounted total) of the cost allocation unit in the previous month * 100%
TrendType String Sequential Comparison Arrow
upward - Upward
downward - Downward
none - Stable
BusinessCode String Product code
BusinessCodeName String Product name: Various cloud products purchased by users
TotalCost String Original price of a component: Original Price = Component List Price * Component Usage * Duration of Use (not displayed if the customer enjoys a fixed price/contract price, and not displayed by default in refund scenarios), specified price mode
RICost String Original price deducted by a reserved instance: The original price of a component deducted by reserved instances for this product or service
SPCost String Savings plan deduction from original price: Savings Plan Deduction from Original Price = Monetary Value of Savings Plan Deduction/ Savings Plan Deduction Rate
CashPayAmount String Cash account expenditure (CNY): The amount paid through the cash account
VoucherPayAmount String Promo voucher expenditure (CNY): The amount paid using various vouchers (such as promo vouchers and cash vouchers)
IncentivePayAmount String Gift account expenditure (CNY): The amount paid using free credits
TransferPayAmount String Royalty account expenditure (CNY): The amount paid through the royalty account
AllocationRealTotalCost String Discounted total: discounted total = (Original Price - Original Price Deducted by a Reserved Instance - Savings Plan Deduction from Original Price) * Discount Rate
GatherTax String Collected fees (tax): Tax directly collected to the cost allocation unit based on the collection rules
AllocateTax String Allocated fees (tax): Resource tax allocated to the cost allocation unit based on the allocation rules
TotalTax String Total fees (tax): Total fees of the cost allocation unit, Collected Fees (Tax) + Allocated fees (Tax)
GatherCostBeforeTax String GatherCostBeforeTax
AllocateCostBeforeTax String AllocateCostBeforeTax
TotalCostBeforeTax String TotalCostBeforeTax
Tax String Tax
CostBeforeTax String CostBeforeTax

AllocationSummaryByItem

Details of a Cost Allocation Bill by item

Used by actions: DescribeAllocationSummaryByItem.

Name Type Description
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit
BillDate String Date: Settlement date
PayerUin String Payer UIN: Account ID of the payer, which is the unique account identifier for the user in Tencent Cloud.
OwnerUin String User UIN: Account ID of the actual resource user
OperateUin String Operator account ID (the resource account ID or role ID opened by prepaid resource ordering or postpaid operation)
PayMode String Billing mode code
PayModeName String Billing mode: Resource billing mode, which can be monthly subscription or pay-as-you-go.
ActionType String Transaction type code
ActionTypeName String Transaction type: Detailed transaction type
BusinessCode String Product code
BusinessCodeName String Product name: Various cloud products purchased by users
ProductCode String Subproduct code
ProductCodeName String Subproduct name: Product subdivision type purchased by the user
RegionId Integer Region ID
RegionName String Region name: The region where the resource is located
ZoneId Integer AZ ID
ZoneName String Availability zone: The availability zone where the resource is located.
InstanceType String Instance type code
InstanceTypeName String Instance type: The type of an instance corresponding to the product service purchased, including resource packages, RI, SP, and spot instances. It is displayed as "-" by default for regular instances.
ResourceId String Resource ID: Resources vary by product, and the content is not identical. For example, Cloud Virtual Machine (CVM) corresponds to the instance ID. If the product is split, it shows the split item ID, such as COS bucket ID and CDN domain name.
ResourceName String Instance name: The name set by the user for the resource in the console, which is empty by default if not set. If the product is split, it shows the split resource alias.
Tag Array of BillTag Allocation tag: The resource-bound tag
ProjectId Integer Project ID
ProjectName String Project name: The Project to which a resource belongs, which is independently allocated by the user for the resource in the console. If a resource has not been allocated to an Project, it will be a default Project.
AllocationType Integer Cost collection type: The source types of fees, including allocated, collection and unallocated.
0 - Allocation
1 - Collection
-1 - Unallocated
TotalCost String Original price of a component: Original Price = Component List Price * Component Usage * Duration of Use (not displayed if the customer enjoys a fixed price/contract price, and not displayed by default in refund scenarios), specified price mode
RiTimeSpan String Reserved instance deduction duration: The duration of use deducted by reserved instances for this product or service.
RiCost String Original price deducted by a reserved instance: The original price of a component deducted by reserved instances for this product or service
RealTotalCost String Discounted total: discounted total = (Original Price - Original Price Deducted by a Reserved Instance - Savings Plan Deduction from Original Price) * Discount Rate
CashPayAmount String Cash account expenditure (CNY): The amount paid through the cash account
VoucherPayAmount String Promo voucher expenditure (CNY): The amount paid using various vouchers (such as promo vouchers and cash vouchers)
IncentivePayAmount String Gift account expenditure (CNY): The amount paid using free credits
TransferPayAmount String Royalty account expenditure (CNY): The amount paid through the royalty account
ItemCode String Component name code
ItemCodeName String Component name: The specific component of a product or service purchased by the user
ComponentCode String Component type code
ComponentCodeName String Component type: The major component category corresponding to the product or service purchased by the user
FeeBeginTime String Usage start time: Usage start time
FeeEndTime String Usage end time: Product or service usage end time
SPCost String Savings plan deduction from original price: Savings Plan Deduction from Original Price = Monetary Value of Savings Plan Deduction/ Savings Plan Deduction Rate
RegionType String Domestic and international codes
RegionTypeName String Domestic and international: Resource region type (domestic, international)
SinglePrice String Component list price: The original unit price of the component on the portal (not displayed if the customer enjoys a fixed price/contract price)
ContractPrice String Component unit price: Discounted unit price of the component. Component unit price = list price * discount.
SinglePriceUnit String Component Price Unit: Unit of component price, Unit Composition: CNY/usage unit/duration unit
UsedAmount String Component usage: The actual settlement usage of the component, Component Usage = Original Component Usage - Deducted Usage (including resource packages)
UsedAmountUnit String Component usage unit: Unit of measurement corresponding to component usage.
TimeSpan String Usage duration: The duration of resource usage, Component Usage = Original Component Usage Duration - Deducted Duration (including resource packages)
TimeUnit String Duration unit: Unit of resource usage duration.
ReserveDetail String Remark attribute (instance configuration): Additional remark information, such as reserved instance type and transaction type for reserved instances, regional information of both ends for CCN products.
RealTotalMeasure String Original usage/duration: The original usage of the component before deduction by resource packages.
(Currently only TRTC, TEM, Cloud Call Center, and CDZ products support this information display. Other products are being integrated.)
DeductedMeasure String Deduction of usage/duration (including resource packages): The amount of usage deducted by resource packages
(Currently only TRTC, TEM, Cloud Call Center, and CDZ products support this information display. Other products are being integrated.)
Discount String Discount rate: The discount rate enjoyed by this resource (it is not shown by default if the customer enjoys a fixed/contract price, and it is also not shown by default in the refund scenario)
BlendedDiscount String Mixed discount rate: The final discount rate after integrating various discount deductions. Mixed Discount Rate = Discounted total price/Original Price.
PriceInfo Array of String Price attribute: Other attributes of the component that affect discount pricing besides unit price and duration
Formula String Calculation rule explanation: A detailed explanation to calculations of billing settlement for special transaction types, such as refund and configuration changes.
FormulaUrl String Billing Rules: The detailed billing rules for each product shown in the portal explanation link
ComponentConfig String Configuration description: Information on specification of resource configuration
SPDeduction String SPDeduction
SPDeductionRate String Savings plan deduction rate: The discount rate for this component within the available balance limit of the savings plan
Currency String Currency.
Tax String Tax
TaxRate String tax rate
CostBeforeTax String CostBeforeTax
AmountBeforeTax String AmountBeforeTax
AssociatedOrder String AssociatedOrder
DiscountObject String Discount object of the current consumption item, such as official website discount, user discount and activity discount.
DiscountType String Discount type of the current consumption item, such as discount and contract price.
DiscountContent String Supplementary description of the offer type, for example: business discount 20% off, the offer type is "discount" and the discount content is "0.8".
BillMonth String Billing month

AllocationSummaryByResource

Detailed summary of the cost allocation bill by resource

Used by actions: DescribeAllocationSummaryByResource.

Name Type Description
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit
BillDate String Date: Settlement date
PayerUin String Payer UIN: Account ID of the payer, which is the unique account identifier for the user in Tencent Cloud.
OwnerUin String User UIN: Account ID of the actual resource user
OperateUin String Operator account ID (the resource account ID or role ID opened by prepaid resource ordering or postpaid operation)
PayMode String Billing mode code
PayModeName String Billing mode: Resource billing mode, which can be monthly subscription or pay-as-you-go.
ActionType String Transaction type code
ActionTypeName String Transaction type: Detailed transaction type
BusinessCode String Product code
BusinessCodeName String Product name: Various cloud products purchased by users
ProductCode String Subproduct code
ProductCodeName String Subproduct name: Product subdivision type purchased by the user
RegionId Integer Region ID
RegionName String Region name: The region where the resource is located
ZoneId Integer AZ ID
ZoneName String Availability zone: The availability zone where the resource is located.
InstanceType String Instance type code
InstanceTypeName String Instance type: The type of an instance corresponding to the product service purchased, including resource packages, RI, SP, and spot instances. It is displayed as "-" by default for regular instances.
ResourceId String Resource ID: Resources vary by product, and the content is not identical. For example, Cloud Virtual Machine (CVM) corresponds to the instance ID. If the product is split, it shows the split item ID, such as COS bucket ID and CDN domain name.
ResourceName String Instance name: The name set by the user for the resource in the console, which is empty by default if not set. If the product is split, it shows the split resource alias.
Tag Array of BillTag Allocation tag: The resource-bound tag
ProjectId Integer Project ID
ProjectName String Project name: The Project to which a resource belongs, which is independently allocated by the user for the resource in the console. If a resource has not been allocated to an Project, it will be a default Project.
AllocationType Integer Cost collection type: The source types of fees, including allocated, collection and unallocated.
0 - Allocation
1 - Collection
-1 - Unallocated
TotalCost String Original price of a component: Original Price = Component List Price * Component Usage * Duration of Use (not displayed if the customer enjoys a fixed price/contract price, and not displayed by default in refund scenarios), specified price mode
RiTimeSpan String Reserved instance deduction duration: The duration of use deducted by reserved instances for this product or service.
RiCost String Original price deducted by a reserved instance: The original price of a component deducted by reserved instances for this product or service
RealTotalCost String Discounted total: discounted total = (Original Price - Original Price Deducted by a Reserved Instance - Savings Plan Deduction from Original Price) * Discount Rate
CashPayAmount String Cash account expenditure (CNY): The amount paid through the cash account
VoucherPayAmount String Promo voucher expenditure (CNY): The amount paid using various vouchers (such as promo vouchers and cash vouchers)
IncentivePayAmount String Gift account expenditure (CNY): The amount paid using free credits
TransferPayAmount String Royalty account expenditure (CNY): The amount paid through the royalty account
FeeBeginTime String Usage start time: Usage start time
FeeEndTime String Usage end time: Product or service usage end time
SPCost String Savings plan deduction from original price: Savings Plan Deduction from Original Price = Monetary Value of Savings Plan Deduction/ Savings Plan Deduction Rate
RegionType String Domestic and international codes
RegionTypeName String Domestic and international: Resource region type (domestic, international)
ComponentConfig String Configuration description: Name and usage of each component under the corresponding resource (the total usage if the component is cumulative usage billing type)
SPDeduction String SPDeduction
Currency String Currency.
Tax String Tax
TaxRate String tax rate
CostBeforeTax String CostBeforeTax
AmountBeforeTax String AmountBeforeTax
BillMonth String Billing month

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.

AllocationTreeNode

Information of the current allocation unit

Used by actions: DescribeAllocationBillConditions, DescribeGatherResource.

Name Type Description
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit

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 code
ActionTypeName String No Transaction type Name

AnalyseAmountDetail

Cost analysis amount return data model

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
Key String No Fee type
Display Integer No Indicates whether to display

AnalyseBusinessDetail

Cost analysis product return complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
BusinessCode String Product code
BusinessCodeName String Product name

AnalyseConditionDetail

Cost analysis filter box complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
Business Array of AnalyseBusinessDetail product
Project Array of AnalyseProjectDetail Project
Region Array of AnalyseRegionDetail Region.
PayMode Array of AnalysePayModeDetail Billing mode.
ActionType Array of AnalyseActionTypeDetail Transaction type
Zone Array of AnalyseZoneDetail Availability zone
OwnerUin Array of AnalyseOwnerUinDetail Resource owner Uin
Amount Array of AnalyseAmountDetail Fee type

AnalyseConditions

Cost analysis query conditions

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
BusinessCodes String No Product name code
ProductCodes String No Subproduct name code
ComponentCode String No Component type code
ZoneIds String No Availability zone ID: The availability zone ID where the resource is located.
RegionIds String No Region ID: Resource region ID
ProjectIds String No Project ID: Project ID of the resource
PayModes String No Billing mode prePay (monthly subscription)/postPay (pay-as-you-go billing)
ActionTypes String No Transaction type. Query transaction type (please use transaction type code as input parameter).
Tags String No Cost allocation tag key
FeeType String No Fee type. Query fee type (please use fee type code input parameter). The input parameter enumeration is as follows:
cashPayAmount: Cash
incentivePayAmount: Bonus
voucherPayAmount: Coupon
tax: tax.
costBeforeTax: pre-tax price
PayerUins String No User UIN for querying cost analysis data
OwnerUins String No User UIN for using resources
ConsumptionTypes String No Consumption type. Query consumption type (please use consumption type code input parameter).

AnalyseDetail

Cost analysis data complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
Name String Time
Total String Amount
TimeDetail Array of AnalyseTimeDetail Date Detail Amount

AnalyseHeaderDetail

Cost analysis header data complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
HeadDetail Array of AnalyseHeaderTimeDetail Header date
Name String Time
Total String total

AnalyseHeaderTimeDetail

Cost analysis header data

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
Name String No Date

AnalyseOwnerUinDetail

Cost analysis user UIN complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
OwnerUin String No User uin

AnalysePayModeDetail

Cost analysis payment method complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
PayMode String No Billing mode code
PayModeName String No Billing mode Name

AnalyseProjectDetail

Cost analysis project return complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
ProjectId String No Project ID
ProjectName String No default project

AnalyseRegionDetail

Cost analysis region return complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
RegionId String No Region ID.
RegionName String No Region name

AnalyseTimeDetail

Cost analysis return value complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Description
Time String Date
Money String Amount

AnalyseZoneDetail

Cost analysis availability zone complex type

Used by actions: DescribeCostExplorerSummary.

Name Type Required Description
ZoneId String No AZ ID.
ZoneName String No Available zone Name

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.

BillActionType

Transaction type filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
ActionType String Yes Transaction type code
ActionTypeName String Yes Transaction type: Detailed transaction type

BillBusiness

Product filter list

Used by actions: DescribeAllocationBillConditions.

Name Type Required Description
BusinessCode String Yes Product code
BusinessCodeName String Yes Product name: Various cloud products purchased by users

Product cascade filter value

Used by actions: DescribeAllocateConditions.

Name Type Description
BusinessCode String Product code
BusinessCodeName String Product name
Children Array of BillProductLink Subproduct

BillComponent

Component type filter list

Used by actions: DescribeAllocationBillConditions.

Name Type Required Description
ComponentCode String Yes Component type code
ComponentCodeName String Yes Component type: The major component category corresponding to the product or service purchased by the user

BillDays

Date filter list

Used by actions: DescribeAllocationBillConditions.

Name Type Required Description
BillDay String Yes Date: Settlement date

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 sub-order number corresponding to the monthly subscription mode. In the postpaid billing model, the bill amount does not exist as an order concept, and this parameter can be ignored.
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.
BusinessCode String Product code
ProductCode String Subproduct code
ActionType String Transaction type code
RegionId String Region ID
ProjectId Integer Project ID
PriceInfo Array of String Price attribute: Other attributes of the component that affect discount pricing besides unit price and duration
AssociatedOrder BillDetailAssociatedOrder Associated transaction document ID: Document ID associated with this transaction, such as a write-off order, the original order, a resettlement order, or the original purchase order number recorded in a refund order.
Formula String Calculation explanation: A detailed explanation to calculations of billing settlement for special transaction types, such as refund and configuration changes.
FormulaUrl String Billing Rules: The detailed billing rules for each product shown in the portal explanation link
BillDay String Billing day
BillMonth String Billing month
Id String Billing record ID
RegionType String Domestic and international codes
RegionTypeName String Domestic and international: Resource region type (domestic, international)
ReserveDetail String Remark attribute (instance configuration): Additional remark information, such as reserved instance type and transaction type for reserved instances, regional information of both ends for CCN products.
DiscountObject String discount object
DiscountType String Offer type
DiscountContent String discount content

BillDetailAssociatedOrder

Information of the document associated with bill details

Used by actions: DescribeBillDetail, DescribeBillDetailForOrganization.

Name Type Description
PrepayPurchase String Newly purchased order
PrepayRenew String Renewal order
PrepayModifyUp String Configuration upgrade order
ReverseOrder String Write-off order
NewOrder String Order after discount adjustment
Original String Order before discount adjustment

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 Original usage/duration: The original usage of the component before deduction by resource packages.
DeductedMeasure String Deduction of usage/duration (including resource packages): The amount of usage/duration deducted by resource packages
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 Royalty account expenditure: The amount paid through the royalty account
ItemCode String Component type code
ComponentCode String Component name code
ContractPrice String Component unit price: Discounted unit price of the component. Component unit price = list price * discount.
InstanceType String Instance type: The type of an instance corresponding to the product service purchased, including resource packages, RI, SP, and spot instances. Normal instance display is not displayed by default.
RiTimeSpan String RI deduction duration: The duration of use deducted by reserved instances for this product or service.
OriginalCostWithRI String Reserved Instance Deduction Component Original Price: The original price of a component deducted by reserved instances for this product or service
SPDeductionRate String Savings plan deduction rate: The discount rate for this component within the available balance limit of the savings plan
OriginalCostWithSP String Original Price of Savings Plan Deduction Component: Savings Plan Deduction from Original Price = Deduction Amount of Savings Plan Package / Savings Plan Deduction Rate
BlendedDiscount String Mixed discount rate: The final discount rate after integrating various discount deductions. Mixed Discount Rate = Discounted total price/Component original price.
ComponentConfig Array of BillDetailComponentConfig Configuration description: Information on specification of resource configuration
TaxRate String tax rate
TaxAmount String Tax.
Currency String Currency.

BillDetailComponentConfig

Bill details configuration descriptions

Used by actions: DescribeBillDetail, DescribeBillDetailForOrganization.

Name Type Description
Name String Configuration description name
Value String Configuration description value

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 Royalty account expenditure: The amount paid through the royalty account
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.
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 month

BillInstanceType

Instance type filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
InstanceType String Yes Instance type code
InstanceTypeName String Yes Instance type: The type of an instance corresponding to the product service purchased, including resource packages, RI, SP, and spot instances. It is displayed as "-" by default for regular instances.

BillItem

Component name filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
ItemCode String Yes Component name code
ItemCodeName String Yes Component name: The specific component of a product or service purchased by the user

BillOperateUin

Operator UIN filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
OperateUin String Yes Operator account ID (the resource account ID or role ID opened by prepaid resource ordering or postpaid operation)

BillOwnerUin

User UIN filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
OwnerUin String Yes User UIN: Account ID of the actual resource user

BillPayMode

Billing mode filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
PayMode String Yes Billing mode code
PayModeName String Yes Billing mode: Resource billing mode, which can be monthly subscription or pay-as-you-go.

BillProduct

Subproduct filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
ProductCode String Yes Subproduct code
ProductCodeName String Yes Subproduct name: Product subdivision type purchased by the user

Subproduct filtering under cost allocation conditions

Used by actions: DescribeAllocateConditions.

Name Type Description
ProductCode String Subproduct code
ProductCodeName String Subproduct name
Children Array of BillItem Component name

BillProject

Project filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
ProjectId Integer Yes Project ID
ProjectName String Yes Project name: The Project to which a resource belongs, which is independently allocated by the user for the resource in the console. If a resource has not been allocated to an Project, it will be a default Project.

BillRegion

Region filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions.

Name Type Required Description
RegionId Integer Yes Region ID
RegionName String Yes Region name: The region where the resource is located

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 Royalty account expenditure: The amount paid through the royalty account
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.
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 month

BillTag

Tag filter list

Used by actions: DescribeAllocateConditions, DescribeAllocationBillConditions, DescribeAllocationBillDetail, DescribeAllocationSummaryByItem, DescribeAllocationSummaryByResource, DescribeGatherResource.

Name Type Required Description
TagKey String Yes Tag key
TagValue String Yes Tag value

BillTagInfo

Bill tag information.

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

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

BillZoneId

Availability zone filter list

Used by actions: DescribeAllocationBillConditions.

Name Type Required Description
ZoneId Integer Yes AZ ID
ZoneName String Yes Availability zone: The availability zone where the resource is located.

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 price in CNY. The TotalCost field comes into effect after bill 3.0 (May 2021) and returns "-" before bill 3.0. In the current situation of contract price, the TotalCost field returns "-" if a price difference exists with the official website price.
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 Royalty account expenditure: The amount paid through the royalty account

BusinessSummaryOverviewItem

Summarize product details by product

Used by actions: DescribeBillSummaryByProduct.

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.
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
IncentivePayAmount String Bonus
VoucherPayAmount String Voucher
TransferPayAmount String Royalty amount
AmountBeforeTax String Cash payment (pre-tax)
Tax String Tax
RegionName String Region name (only shown in regional summary)

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
IncentivePayAmount String Bonus
VoucherPayAmount String Voucher
TransferPayAmount String Royalty amount
Tax String Tax
AmountBeforeTax String Cash payment (pre-tax)

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
VoucherPayAmount String Voucher
IncentivePayAmount String Bonus
TransferPayAmount String Royalty amount
Tax String Tax
AmountBeforeTax String Cash payment (pre-tax)

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 Original price
FeeBeginTime String Fee start time
FeeEndTime String End time of fees
DayDiff String Days
DailyTotalCost String Daily consumption
OrderId String Order ID
VoucherPayAmount String Voucher
IncentivePayAmount String Bonus
TransferPayAmount String Royalty amount
Tax String Tax
TaxRate String tax rate
AmountBeforeTax String Cash payment (pre-tax)
PayerUin String Payer UIN: Account ID of the payer, which is the unique account identifier for the user in Tencent Cloud.
OwnerUin String User UIN: Account ID of the actual resource user
OperateUin String Operator UIN: Operator account ID (ID of the operator who places orders for prepaid resources or activates postpaid resource account, or role ID).
ProductCode String Subproduct code
ProductCodeName String Subproduct name: Product subdivision type purchased by the user, such as Cloud Virtual Machine (CVM)-Standard Type S1
RegionType String Region type
RegionTypeName String Region type name.
Extend1 String Extension Field 1
Extend2 String Extension Field 2
Extend3 String Extension Field 3
Extend4 String Extension Field 4
Extend5 String Extension Field 5
InstanceType String Instance type
InstanceTypeName String Instance Type Name
PayTime String Deduction time: Deduction time
ZoneName String Availability zone: The availability zone where the resource is located, such as Guangzhou Zone 3.
ComponentConfig String Describing Configurations
Tags String Tag information.

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 of this field is null when Type is none.

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
Tax String Tax
TaxRate String tax rate

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 name
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
Tags Array of BillTagInfo Tag information.

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.
ZoneCode String Availability zone Id corresponding to the order

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.
BusinessCode String Product code
ProductCode String Subproduct code
ActionType String Transaction type code
RegionId String Region ID
ProjectId Integer Project ID.
PriceInfo Array of String Price attribute: Other attributes of the component that affect discount pricing besides unit price and duration
AssociatedOrder BillDetailAssociatedOrder Associated transaction document ID: Document ID associated with this transaction, such as a write-off order, the original order, a resettlement order, or the original purchase order number recorded in a refund order.
Formula String Calculation explanation: A detailed explanation to calculations of billing settlement for special transaction types, such as refund and configuration changes.
FormulaUrl String Billing Rules: The detailed billing rules for each product shown in the portal explanation link
BillMonth String Billing month
BillDay String Billing day

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.

GatherResourceSummary

Resource collection summary

Used by actions: DescribeGatherResource.

Name Type Description
PayerUin String Payer UIN: Account ID of the payer, which is the unique account identifier for the user in Tencent Cloud.
OwnerUin String User UIN: Account ID of the actual resource user
OperateUin String Operator account ID (the resource account ID or role ID opened by prepaid resource ordering or postpaid operation)
InstanceType String Instance type code
InstanceTypeName String Instance type: The type of an instance corresponding to the product service purchased, including resource packages, RI, SP, and spot instances. It is displayed as "-" by default for regular instances.
ResourceId String Resource ID: Resources vary by product, and the content is not identical. For example, Cloud Virtual Machine (CVM) corresponds to the instance ID. If the product is split, it shows the split item ID, such as COS bucket ID and CDN domain name.
ResourceName String Instance name: The name set by the user for the resource in the console, which is empty by default if not set. If the product is split, it shows the split resource alias.
TreeNodeUniqKey String Unique identifier of a cost allocation unit
TreeNodeUniqKeyName String Name of a cost allocation unit
RuleId Integer Allocation rule ID hit by the resource
RuleName String Allocation rule name hit by the resource
BusinessCode String Product code
BusinessCodeName String Product name: Various cloud products purchased by users
ItemCode String Component name code
ItemCodeName String Component name: The specific component of a product or service purchased by the user
RegionId Integer Region ID
RegionName String Region name: The region where the resource is located
Tag Array of BillTag Allocation tag: The resource-bound tag
RealTotalCost String Discounted total: discounted total = (Original Price - Original Price Deducted by a Reserved Instance - Savings Plan Deduction from Original Price) * Discount Rate
CashPayAmount String Cash account expenditure (CNY): The amount paid through the cash account
VoucherPayAmount String Promo voucher expenditure (CNY): The amount paid using various vouchers (such as promo vouchers and cash vouchers)
IncentivePayAmount String Gift account expenditure (CNY): The amount paid using free credits
TransferPayAmount String Royalty account expenditure (CNY): The amount paid through the royalty account
AllocationType Integer Cost collection type: The source types of fees, including allocated, collection and unallocated.
0 - Allocation
1 - Collection
-1 - Unallocated
BelongTreeNodeUniqKey AllocationTreeNode Information of the current allocation unit
BelongRule AllocationRule Information on allocation rules hit by the current resource
OtherTreeNodeUniqKeys Array of AllocationTreeNode Information on other allocation units
OtherRules Array of AllocationRule Information on other hit rules
ProjectId Integer Project ID
ProjectName String Project name: The Project to which a resource belongs, which is independently allocated by the user for the resource in the console. If a resource has not been allocated to an Project, it will be a default Project.
ProductCode String Subproduct code
ProductCodeName String Subproduct name: Product subdivision type purchased by the user
PayMode String Billing mode code
PayModeName String Billing mode: Resource billing mode, which can be monthly subscription or pay-as-you-go.
ActionType String Transaction type code
ActionTypeName String Transaction type: Detailed transaction type

GatherRuleSummary

List of collection rules.

Used by actions: CreateGatherRule.

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

OperateRsp

Operate related resources return detail

Used by actions: SetRenewal.

Name Type Description
Code Integer Operation failure code at the instance dimension
Note: This field may return null, indicating that no valid values can be obtained.
Message String Failure reason for operating related resources
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance ID.
Note: This field may return null, indicating that no valid values can be obtained.

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

RenewInstance

Resource instance information

Used by actions: DescribeRenewInstances.

Name Type Required Description
InstanceId String No Instance ID.
ProductCode String No Product code
SubProductCode String No Subproduct code
RegionCode String No Region encoding
Note: This field may return null, indicating that no valid values can be obtained.
Status String No Instance status:
NORMAL
ISOLATED Isolated
Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag String No Renewal flag:
NOTIFY_AND_MANUAL_RENEW: manual renewal
NOTIFY_AND_AUTO_RENEW: auto-renewal.
DISABLE_NOTIFY_AND_MANUAL_RENEW: non-renewal upon expiration.
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime String No Instance expiration time.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String No Instance alias: The name set by the user for the instance in the console, which is empty by default if not set.
Note: This field may return null, indicating that no valid values can be obtained.
ProductName String No Product name: Cloud products purchased by users, such as Cloud Virtual Machine (CVM)
Note: This field may return null, indicating that no valid values can be obtained.
ProjectName String No Project name: Instance Ownership of the project. User can autonomously assign project to the instance on the console. Default project if not allocated.
Note: This field may return null, indicating that no valid values can be obtained.
RenewPeriod Integer No Automatic renewal cycle length
Note: This field may return null, indicating that no valid values can be obtained.
RenewPeriodUnit String No Automatic renewal cycle unit: y year, m month
Note: This field may return null, indicating that no valid values can be obtained.

ResourceSpuSet

Quotation for 4-tier product details

Used by actions: DescribeCPQBillingMapping.

Name Type Required Description
SpuNameZh String No Quoted subproduct (Chinese)
SpuNameEn String No Quoted subproduct (English)
CategoryNameZh String No Quoted product (Chinese)
CategoryNameEn String No Quoted product (English)
BusinessCode String No Product code
BusinessNameZh String No Product name (Chinese)
BusinessNameEn String No Product name (English)
ProductCode String No Subproduct code
ProductNameZh String No Subproduct name (Chinese)
ProductNameEn String No Subproduct name (English)
ComponentCode String No Component type code
ComponentNameZh String No Component type name (Chinese)
ComponentNameEn String No Component type name (English)
ItemCode String No Component code
ItemNameZh String No Component name (Chinese)
ItemNameEn String No Component name (English)

SummaryDetail

Detailed summary of costs by multiple dimensions

Used by actions: DescribeBillSummary, DescribeBillSummaryForOrganization.

Name Type Description
GroupKey String Bill dimension code
GroupValue String Billing dimension value
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 Royalty account expenditure: The amount paid through the royalty account
Business Array of BusinessSummaryInfo Product summary information

SummaryTotal

Total cost

Used by actions: DescribeBillSummaryByTag.

Name Type Description
RealTotalCost String discounted total price
TotalCost String Original price in CNY. The TotalCost field comes into effect after bill 3.0 (May 2021) and returns "-" before bill 3.0. In the current situation of contract price, the TotalCost field returns "-" if a price difference exists with the official website price.

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 Set the allocation tag time. Ordinary tags do not return.

TagSummaryOverviewItem

Details about cost distribution over different tags.

Used by actions: DescribeBillSummaryByTag.

Name Type Description
TagValue String Tag value
RealTotalCostRatio String Percentage of the fee, with 2 decimal places.
RealTotalCost String discounted total price
CashPayAmount String Cash account expenditure: The amount paid through the cash account
IncentivePayAmount String Gift account expenditure: The amount paid using free credits
VoucherPayAmount String Coupon expenditure: The amount paid using various vouchers (such as vouchers and cash vouchers)
TransferPayAmount String Royalty account expenditure: The amount paid through the royalty account
TotalCost String Original price in CNY. The TotalCost field comes into effect after bill 3.0 (May 2021) and returns "-" before bill 3.0. In the current situation of contract price, the TotalCost field returns "-" if a price difference exists with the official website price.

UinTempAmountModel

Temporary limit details

Used by actions: DescribeAccountBalance.

Name Type Description
Uin String User UIN
TempAmount Float temporary limit
StartTime String Start time.
EndTime String End time.

UsageDetails

The product purchased.

Used by actions: DescribeVoucherUsageDetails.

Name Type Description
ProductName String Product name
SubProductName String product details
ProductCode String Product code
SubProductCode String Sub-product code
BillingItemCode String Billing item code.
SubBillingItemCode String Billing sub-item code.
ProductEnName String Product English Name
SubProductEnName String English name of the sub-product.
CalcUnit String billing cycle
Action String payMode is prepay and payScene is common in the current situation

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 Usage record details
PayMode String Payment mode
VoucherId String Queried coupon id
PayScene String Transaction scene: (adjust: adjust accounts, common: normal transaction scene)
SeqId String Unique ID, corresponding to transaction: prepaid dealName, bill adjustment/postpaid outTradeNo

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 Product information applies to
ExcludedProducts Array of ExcludedProducts Product information not applicable
PolicyRemark String Instructions/Batch Remarks
CreateTime String Coupon issuance time
Previous Topic: DescribeBillDetailForOrganizationNext Topic: Error Codes

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback