tencent cloud

All product documents
APIs
DocumentationAPIsInternational PartnersBill Management APIsDescribeBillDownloadUrl
DescribeBillDownloadUrl
Last updated: 2025-02-27 10:07:01
DescribeBillDownloadUrl
Last updated: 2025-02-27 10:07:01

1. API Description

Domain name for API request: intlpartnersmgt.intl.tencentcloudapi.com.

Description: This API is used to download billing files and return billing file URLs for sub-customers.
Callable role: Enb-customer.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DescribeBillDownloadUrl.
Version Yes String Common Params. The value used for this API: 2022-09-28.
Region No String Common Params. This parameter is not required.
Month Yes String The month to which the bill belongs, formatted as YYYY-MM; the earliest month available for query is June, 2022. Current month's billing data may be inaccurate; please download the current month's bill after it is generated at 1:00 on the 5th of the next month.
FileType Yes String Type of bill. Valid values: L2 or L3

3. Output Parameters

Parameter Name Type Description
DownloadUrl String File download link, with a file validity period of 1 hour
Ready Integer File generation status. 0: generating; 1: generated.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 DescribeBillDownloadUrl-1

Sub-customer retrieves their billing link. Request for file generation is in progress, please wait for the file generation to complete before downloading again.

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillDownloadUrl
<Common request parameters>

{
    "Month": "2023-12",
    "FileType": "L3"
}

Output Example

{
    "Response": {
        "DownloadUrl": "",
        "Ready": 0,
        "RequestId": "1737bf56-fbb4-4a57-a08b-73901b74abf3"
    }
}

Example2 DescribeBillDownloadUrl-2

Sub-customer retrieves their billing link. The file has been generated, please use the download link to get the file.

Input Example

POST / HTTP/1.1
Host: intlpartnersmgt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillDownloadUrl
<Common request parameters>

{
    "Month": "2024-12",
    "FileType": "L2"
}

Output Example

{
    "Response": {
        "DownloadUrl": "https://xxxx.cos.ap-singapore.myqcloud.com/L3-bill_details.csv",
        "Ready": 1,
        "RequestId": "845ac46e-20a7-4cab-8930-d5e6d2104885"
    }
}

5. Developer Resources

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
FailedOperation Operation failed.
InvalidParameter Invalid parameter
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support