tencent cloud

International Partners

Release Notes
Introduction to Channel Partners
Partner Type and Level
Partner Platform Function Overview
User Guide (Reseller)
Become a Partner
Sign in to Partner Center
Account and Organization Information Management
Customer Management
Reseller Management
Managing Reseller
Expense Management
Commission Management
Agreement Management
User Guide (Customer)
Invited to Bind as a Customer
Unbind Reseller
Account Management
Product Purchase
Renewal Management
Bill Management
Cost Management
Agreement Management
User Guide (Partner Academy)
Partner Academy Guide
Becoming an MSP
Becoming a CSP
Agreement Management
Security and Compliance
Access Management
API Documentation
History
Introduction
API Category
Making API Requests
Customer Management APIs
Credit Management APIs
Agent APIs
Bill Management APIs
Voucher Management APIs
Commission Management APIs
Data Types
Error Codes
FAQs
Partner Onboarding
End Customer Relationship Management
Credit Management
Vouchers
Purchase Transactions
Discount Management
About Bills
Organization Management
Contact Us
Glossary
DocumentaçãoInternational PartnersAPI DocumentationVoucher Management APIsDescribeCustomerOwnVoucherList

DescribeCustomerOwnVoucherList

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2025-10-30 21:45:22

1. API Description

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

This API is used to query the voucher list by Customer.
Callable roles: 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: DescribeCustomerOwnVoucherList.
Version Yes String Common Params. The value used for this API: 2022-09-28.
Region No String Common Params. This parameter is not required.
Page Yes Integer Page number, starts from 1.
PageSize Yes Integer Number of items per page. value range: 1-100.
VoucherStatus No String Voucher status. valid values: Issued, Used, Expired, Invalidated.
PaymentMode No String Payment mode. valid values: AllPayment, Prepaid, Postpaid.
ProductScope No String Applicable product. valid values: AllProducts, SpecifyProducts, SpecifyProductsBlacklist.
VoucherId No Integer Voucher ID.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of the list.
Data Array of DescribeCustomerOwnVoucherItem Voucher information description.
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 Query Succeeded

This example shows you how to query successfully.

Input Example

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

{
    "Page": 1,
    "PageSize": 1
}

Output Example

{
    "Response": {
        "Data": [
            {
                "CustomerUin": 800000234475,
                "EffectiveTime": "2025-07-29 10:59:39",
                "ExpireTime": "2025-08-28 23:59:59",
                "PaymentMode": "Prepaid",
                "ProductScope": "SpecifyProductsBlacklist",
                "RemainingAmount": 2,
                "TotalAmount": 2,
                "VoucherId": 12348270,
                "VoucherStatus": "Invalidated"
            }
        ],
        "RequestId": "e106fce6-7c1c-4d06-936b-e581ed07926b",
        "TotalCount": 11221
    }
}

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.
Anterior: DescribeCustomerVoucherListPróximo: DescribeRebateDownloadUrl

Ajuda e Suporte

Esta página foi útil?

comentários