Help & DocumentationContent Delivery NetworkAPI Documentation Service Query APIsDescribePayType

DescribePayType

Last updated: 2020-01-13 16:24:50

PDF

Contents：

1. API Description

Domain name for API request: cdn.tencentcloudapi.com.

This API (DescribePayType) is used to query billing information of the current account, such as billing mode and billing cycle.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribePayType
Version Yes String Common parameter. The value used for this API: 2018-06-06
Region No String Common parameter. This parameter is not required for this API.
Area No String Specifies a service region.
mainland: queries billing methods within Mainland China;
overseas: queries billing methods outside Mainland China.
Default value: mainland.

3. Output Parameters

Parameter Name Type Description
PayType String Billing modes:
flux: bill-by-traffic
bandwidth: bill-by-bandwidth
When you switch the billing mode for a daily-billing-cycle account, if there is bandwidth usage on the day, this field indicates the billing mode that will take effect on the next day; otherwise, it indicates the billing mode that has already taken effect
BillingCycle String Billing cycle:
day: daily settlement
month: monthly settlement
StatType String Billing method:
monthMax: billed by the monthly average of daily peak traffic (monthly settlement)
day95: billed by the daily 95th percentile bandwidth (monthly settlement)
month95: billed by the monthly 95th percentile bandwidth (monthly settlement)
sum: billed by the total traffic (daily or monthly settlement)
max: billed by the peak bandwidth (daily settlement)
RegionType String Billing method outside Mainland China:
all: unified billing for all regions
multiple: separate billing for different regions
CurrentPayType String Currently billing mode in effect:
flux: bill-by-traffic
bandwidth: bill-by-bandwidth
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying billing method

Input Example

https://cdn.tencentcloudapi.com/?Action=DescribePayType
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "1732a0dd-48d8-4ff1-8dcb-7f04ca139825",
    "PayType": "flux",
    "StatType": "sum",
    "BillingCycle": "day",
    "RegionType": "all",
    "CurrentPayType": "flux",
    "IsVip": 0
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.CdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.CdnUserNoWhitelist You are not in the beta whitelist and thus have no permission to use this function.