ListCoupons - 查询代金券信息--费用中心-火山引擎

文档中心

立即注册

导航

ListCoupons - 查询代金券信息

最近更新时间：2025.08.21 10:29:02首次发布时间：2025.08.14 21:36:17

查询代金券信息

注意事项

查询QPS限制为10QPS超过会报错

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListCoupons	要执行的操作，取值：ListCoupons。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
ValidBeginTime	String	否	2022-02-02T12:00:00Z	代金券生效时间范围开始时间
ValidEndTime	String	否	2022-02-02T12:00:00Z	代金券生效时间范围结束时间
ProductCode	String	否	ECS	商品Code
Status	String	否	2	代金券状态（多个用英文逗号分隔）
Limit	Integer	否	10	每页返回的数据量
Offset	Integer	否	0	偏移量
CouponID	String	否	DT4CC6IB2IZB8D1H	代金券ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
List	Array of Object	[]	代金券列表
Total	Integer	10	总数
Limit	Integer	10	Limit
Offset	Integer	0	Offset

请求示例

POST /open-apis-v2/coupon?Action=ListCoupons&Version=2022-01-01 HTTP/1.1
Host:
Accept: application/json
Accept-Encoding: gzip
Authorization: ******
Content-Type: application/json; charset=utf-8

{
  "Limit": 10,
  "Offset": 0,
  "ProductCode": "YJQceshi,on_line",
  "ValidBeginTime": "2024-10-16T15:59:59Z",
  "ValidEndTime": "2024-10-20T15:59:59Z"
}

返回示例

{
  "Metadata": {
    "RequestId": "20250813192131978261F85B58C706552F",
    "Action": "ListCoupons",
    "Version": "2022-01-01",
    "Service": "billing",
    "Region": "cn-north-1",
    "HTTPCode": 200
  },
  "Limit": 10,
  "List": [
    {
      "AccountID": 2000010593,
      "AcquireTime": "2024-10-17T11:14:53+08:00",
      "AmountLimit": 0,
      "AssignedOwnerIDList": [],
      "BeginTime": "2024-10-17T11:14:53+08:00",
      "CouponID": "D6JVHMZ6WWQ1NVRW",
      "CouponName": "火山引擎代金券",
      "ExpiredTime": "2024-10-20T23:59:59+08:00",
      "OrderTypeLimit": "1,6,3,4,9",
      "PayTypeLimit": "all",
      "ProductLimitList": [
        {
          "BillingMethod": "",
          "ChargeItemCode": "",
          "ChargeItemType": 0,
          "ConfigurationCode": "",
          "ConfigurationName": "",
          "ConfigurationType": 1,
          "ProductCode": "YJQceshi",
          "ProductName": "YJQceshi",
          "TimeLimitLower": -1,
          "TimeLimitUpper": -1
        }
      ],
      "RemainingAmount": 10,
      "Remark": "系统回收",
      "Status": 5,
      "TotalAmount": 10,
      "UsageLimit": 2
    }
  ],
  "Offset": 0,
  "Total": 1
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParam	The parameter %s is invalid.	参数无效
500	InternalError	Service has some internal Error. Pls Contact With Admin.	服务内部异常