查询优惠券收支明细-ListCustomerAccountChangeRecords
功能介绍
客户可以查询自身优惠券的收支明细情况。
接口约束
该接口只允许使用客户的AK/SK或者Token调用。
此接口不适用于伙伴的转售类客户。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见策略授权参考。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
描述
访问级别
资源类型(*为必须)
条件键
别名
billing:balance:view
授予查看收支明细,付款历史记录,消费配额,调账记录,欠费查询的权限
list
-
-
-
URI
GET /v2/promotions/benefits/account-change-records
参数说明请参见下表。
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
balance_type |
是 |
String |
参数解释: 账户类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
revenue_expense_type |
否 |
String |
参数解释: 收支类型。 约束限制: 此参数不携带时,不作为筛选条件;此参数携带值不允许为空、空串,有枚举值校验。 取值范围:
默认取值: 不涉及 |
|
trade_id |
否 |
String |
参数解释: 交易ID/订单ID。 约束限制: 此参数不携带、携带值为空时,不作为筛选条件。 取值范围: 最大长度:128 默认取值: 不涉及 |
|
trade_type |
否 |
String |
参数解释: 交易类型。 约束限制: 此参数不携带时,不作为筛选条件;此参数携带值不允许为空、空串,有枚举值校验。 取值范围:
默认取值: 不涉及 |
|
trade_time_begin |
否 |
String |
参数解释: 查询收支明细的开始日期。 东八区时间,格式为YYYY-MM-DD,如“2017-10-21”。 约束限制: 此参数不携带、携带值为空时,默认值为一年前的当天日期;此参数不允许携带值为空串,有参数校验。 取值范围: 最大长度:10 默认取值: 一年前的当天日期。 |
|
trade_time_end |
否 |
String |
参数解释: 查询收支明细的结束日期。 东八区时间,格式为YYYY-MM-DD,如“2017-12-21”。 约束限制: 此参数不携带、携带值为空时,默认值为当前日期;此参数不允许携带值为空串,有参数校验。 取值范围: 最大长度:10 默认取值: 当前日期。 |
|
coupon_id |
否 |
String |
参数解释: 优惠券ID。 约束限制: 此参数不携带或携带值为空时,不作为筛选条件。 取值范围: 最大长度:64 默认取值: 不涉及 |
|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。
说明:
offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。 约束限制: 此参数不携带或携带值为空时,默认传参为0。 取值范围: [0-最大整数] 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 每次查询的数量。 约束限制: 此参数不携带或携带值为空时,默认传参为10。 取值范围: [1-100] 默认取值: 10 |
请求消息
请求参数
无
请求示例
GET https://bss.myhuaweicloud.com/v2/promotions/benefits/account-change-records?balance_type=BALANCE_TYPE_COUPON&trade_id=4511415621224&trade_type=RECHARGE&trade_time_begin=2020-10-20&trade_time_end=2021-10-20&offset=0&limit=10 HTTP/1.1
Content-Type: application/json
X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 状态码。具体参见状态码。只有失败才会返回这个参数。 取值范围: 最大长度:20 |
|
error_msg |
String |
参数解释: 错误描述信息。只有失败才会返回这个参数。 取值范围: 最大长度:2000 |
|
total_count |
Integer |
参数解释: 返回总条数。 |
|
currency |
String |
参数解释: 币种。 CNY:人民币。 取值范围: 最大长度:4 |
|
records |
List<CustomerCouponChangeRecord> |
参数解释: 优惠券收支明细记录列表。 具体请参见表2。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
coupon_id |
String |
参数解释: 优惠券ID。 取值范围: 最大长度:64 |
|
trade_detail_type |
String |
参数解释: 交易详细类型。
取值范围: 最大长度:128 |
|
trade_time |
String |
参数解释: 交易时间。 UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2016-03-28T14:45:38Z”。 取值范围: 最大长度:20 |
|
trade_id |
String |
参数解释: 交易ID/订单ID。 取值范围: 最大长度:128 |
|
change_amount |
String |
参数解释: 变更金额,单位为元。 取值范围: 最大长度:64 |
|
balance_after_change |
String |
参数解释: 变更后余额,单位为元。 取值范围: 最大长度:64 |
|
revenue_expense_type |
String |
参数解释: 收支类型。
取值范围: 最大长度:64 |
|
bill_cycle |
String |
参数解释: 账期。 取值范围: 最大长度:7 |
|
account_name |
String |
参数解释: 账号名称。 取值范围: 最大长度:128 |
|
cloud_service_type_name |
String |
参数解释: 云服务类型名称。 取值范围: 最大长度:200 |
|
resource_type_name |
String |
参数解释: 资源类型名称。 取值范围: 最大长度:200 |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"total_count": 1,
"currency": "CNY",
"records": [
{
"coupon_id": "AC-8500000373-0",
"trade_detail_type": "SOURCE_OPERAIION_RECHARGE",
"trade_time": "2021-04-02T06:05:38Z",
"trade_id": "CB123456",
"change_amount": "1053.35",
"balance_after_change": "0.00",
"revenue_expense_type": "REVENUE",
"bill_cycle": "2018-08",
"account_name":"hw83****62",
"cloud_service_type_name":"弹性云服务器",
"resource_type_name":"云主机
}
]
}
