# 查询购买资源包的用量情况

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

getUsageDetail

# 功能描述

小程序可通过本接口查询已购买资源包的用量情况；

# 调用方式

# HTTPS 调用


GET https://api.weixin.qq.com/wxa/charge/usage/get?access_token=ACCESS_TOKEN

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：18
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token可通过getAccessToken接口获得。
spuId	string	是	商品SPU ID
offset	number	是	分页偏移量，从0开始
limit	number	是	每页个数，最大20

# 返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
effectiveUse	string	累计用量（64位数字），用于资源包类商品
~~effectiveAll~~	~~string~~	~~资源总量（64位数字），用于资源包类商品~~
all	string	资源可用总量（64位数字），用于资源包类商品
startServiceTime	number	订阅开始时间戳（单位：秒），用于订阅类商品
endServiceTime	number	订阅结束时间戳（单位：秒），用于订阅类商品
total	number	用量详情列表总数
detailList	array	用量详情列表

all字段具体含义：

每项付费能力正常收费期间：当前生效的资源包的总量（和原effectiveAll含义相同，原字段废弃）
每项付费能力预公告收费，但未正式计费期间：当前生效以及购买后未生效的资源包的总量

# UsageDetail

属性	类型	说明
pkgId	string	资源包ID
status	number	资源包状态，定义参考PackageStatus
startTime	number	额度有效期开始时间戳（单位：秒）
endTime	number	额度有效期至结束时间戳（单位：秒）
all	string	额度容量（64位数字）
used	string	使用额度（64位数字）
spuId	string	额度来源的商品SPU ID（64位数字）
skuId	string	额度来源的商品SKU ID（64位数字）
source	number	额度来源，定义参考PackageSource

# PackageStatus

资源包状态的枚举值

值	说明
1	生效中
2	未生效
3	已失效

# PackageSource

资源包来源的枚举值

值	说明
1	体验额度
2	付费购买
3	服务商分配
4	其他
5	其他

# 调用示例

示例说明: HTTPS调用

# 请求数据示例

GET https://api.weixin.qq.com/wxa/charge/usage/get?access_token={{SP_ACCESS_TOKEN}}&amp;spuId=10000001&amp;offset=0&amp;limit=10

# 返回数据示例

{
  "errcode": 0,
  "all": "10",
  "effectiveAll": "10",
  "effectiveUse": "0",
  "startServiceTime": 1669129510,
  "endServiceTime": 1709450190,
  "total": 2,
  "detailList": [
    {
      "pkgId": "ZY2823973277692477440",
      "startTime": 1677914190,
      "endTime": 1709450190,
      "used": "0",
      "all": "4",
      "status": 1,
      "spuId": "10000057",
      "skuId": "20000059"
    },
    {
      "pkgId": "ZY2676590816357400576",
      "startTime": 1669129510,
      "endTime": 1700665510,
      "used": "0",
      "all": "6",
      "status": 1,
      "spuId": "10000057",
      "skuId": "20000060"
    }
  ]
}

# 错误码

错误码	错误码取值	解决方案
10120002	参数错误
10120003	limit参数过大	调小limit的数值