tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBillDownloadUrl

Last updated: 2024-05-28 17:26:58

    1. API Description

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

    This API is used to get bill download URLs for L0, L1, L2, and L3 bills and bill packs.

    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: 2018-07-09.
    Region No String Common Params. This parameter is not required.
    FileType Yes String Bill type. Valid values:
    billOverview (L0: PDF bills)
    billSummary (L1: Bill summary)
    billResource (L2: Bill by instance)
    billDetail (L3: Bill details)
    billPack (Bill packs)
    Month Yes String Bill month.
    The earliest month that can be queried is January 2021.
    L0 bills and bill packs cannot be downloaded for the current month. Please download the current month's bills after it is generated at 19:00 on the 1st day of the next month.
    ChildUin.N No Array of String List of account IDs for downloading the bill. By default, it queries the bill for the current account. If you are an admin account and need to download bills for member accounts with their own payment, input the member account's UIN for this parameter.

    3. Output Parameters

    Parameter Name Type Description
    Ready Integer Indicates whether the bill file is ready. Valid values: 0 (the file is being generated), 1 (the file has been generated).
    DownloadUrl String Billing file download link, valid for 1 day. Note: This field may return null, indicating that no valid values can be obtained.
    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 Getting bill download URLs

    This example shows you how to get bill download URLs.

    Input Example

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

{
    "FileType": "billPack",
    "Month": "2023-08"
}

    Output Example

    {
    "Response": {
        "DownloadUrl": "http://xxxxxxxxxxxxxxxxx",
        "Ready": 1,
        "RequestId": "3efd37d8-68aa-4bfc-8f8c-f8a0197f9931"
    }
}

    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
    InternalError Internal error.
    InternalError.GatewayError Gateway error.
    InvalidParameter Invalid parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy