# 查询已购资源包的用量情况
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。
接口英文名：getSPUsageDetail
服务商可通过本接口查询已购买资源包的用量情况。
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/wxa/charge/service-provider/usage/get?access_token=ACCESS_TOKEN&spuId=SPUID&offset=OFFSET&limit=LIMIT&status=STATUS
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 access_token |
| spuId | string | 是 | 商品SPU ID |
| offset | number | 是 | 分页偏移量，从0开始 |
| limit | number | 是 | 每页个数，最大20 |
| status | number | 否 | 资源包状态 |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| effectiveUse | string | 累计用量（64位数字），用于资源包类商品 |
| effectiveAll | string | 资源总量（64位数字），用于资源包类商品（已废弃） |
| all | string | 资源可用总量（64位数字），用于资源包类商品。详情见其他说明 |
| total | number | 用量详情列表总数 |
| detailList | objarray | 用量详情列表 |
# Res.detailList(Array) Object Payload
用量详情列表
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| pkgId | string | 资源包ID | - |
| status | number | 资源包状态 | 枚举值 |
| startTime | number | 额度有效期开始时间戳（单位：秒） | - |
| endTime | number | 额度有效期至结束时间戳（单位：秒） | - |
| all | string | 额度容量（64位数字 | - |
| used | string | 使用额度（64位数字） | - |
| spuId | string | 额度来源的商品SPU ID（64位数字） | - |
| skuId | string | 额度来源的商品SKU ID（64位数字） | - |
| source | number | 额度来源 | 枚举值 |
# 4. 枚举信息
# Res.detailList(Array).status Enum
资源包状态
| 枚举值 | 描述 |
|---|---|
| 1 | 生效中 |
| 2 | 未生效 |
| 3 | 已失效 |
# Res.detailList(Array).source Enum
额度来源
| 枚举值 | 描述 |
|---|---|
| 1 | 体验额度 |
| 2 | 付费购买 |
| 3 | 服务商分配 |
| 4 | 其他 |
| 5 | 其他 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
GET https://api.weixin.qq.com/wxa/charge/usage/get?access_token={{SP_ACCESS_TOKEN}}&spuId=10000001&offset=0&limit=10
返回示例
{
"errcode": 0,
"all": "10",
"effectiveUse": "0",
"total": 2,
"detailList": [
{
"pkgId": "ZY2823973277692477440",
"startTime": 1677914190,
"endTime": 1709450190,
"used": "0",
"all": "4",
"status": 1,
"spuId": "10000057",
"skuId": "20000059",
"orderId": "DD2981741311549200000"
},
{
"pkgId": "ZY2676590816357400576",
"startTime": 1669129510,
"endTime": 1700665510,
"used": "0",
"all": "6",
"status": 1,
"spuId": "10000057",
"skuId": "20000060",
"orderId": "DD2981741311549200001"
}
]
}
# 7. 错误码
此接口没有特殊错误码，可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 8. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明，均不可调用。