账户账单接口

这篇文档讲述了白标伙伴如何通过API查询客户的WhatsApp费用

你可以通过调用日账单API，获取您站点客户的WhatsApp费用

日账单接口

接口地址： https://api.ycloud.com/v2/billing/usageDetails

功能描述：按天分页返回账单数据。分组依据：日期（按天，固定 UTC+8 时区）、发送地区、消息渠道（WhatsApp、短信、语音、邮件）、WABA ID（仅限 WhatsApp 渠道）。排序方式：日期倒序。

请求方法： GET

请求头：

X-API-Key	【必需】账号 API Key，进入控制台查看。
X-Managed-Account-ID	仅适用于白标合作伙伴。 如果您的账号下拥有一个或多个受管理账号，则可以指定一个受管理账号 ID，这会使您以受管理账号的身份发起请求从而获得其账单数据。

请求参数：

page	页码，整数，区间 [1,100]。 默认值 1。
limit	分页大小，整数，区间 [1,100]。 默认值 10。
includeTotal	是否返回总记录数，取值 true / false，默认 false。
filter.startDate	【必需】账单起始日期（含），格式 yyyy-MM-dd，示例 2024-01-31
filter.endDate	【必需】账单截止日期（含），格式 yyyy-MM-dd，示例 2024-01-31
filter.wabaId	WABA ID

请求示例：

curl 'https://api.ycloud.com/v2/billing/usageDetails?page=1&limit=10&includeTotal=false&filter.startDate=2024-01-01&filter.endDate=2024-01-31&filter.wabaId=WABA-ID' \
-H 'X-API-Key: {{YOUR-API-KEY}}'

响应示例：

{
  "offset": 0,
  "limit": 10,
  "total": 1,
  "length": 1,
  "items": [
    {
      "date": "2024-03-06",
      "isTransient": true,
      "channel": "whatsapp",
      "wabaId": "WABA_ID",
      "regionCode": "CN",
      "costItems": [
        {
          "cost": 1.0,
          "unitPrice": 0.1,
          "quantity": 10,
          "conversationOriginType": "authentication"
        },
        {
          "cost": 3.0,
          "unitPrice": 0.2,
          "quantity": 15,
          "conversationOriginType": "utility"
        }
      ]
    }
  ]
}

响应字段：

offset, limit 等通用字段略，见 Pagination。

返回的 items[] 对象字段如下：

date	string	账单日期，格式 yyyy-MM-dd，示例 2024-01-31
isTransient	boolean	是否暂时的。对于昨日或今日准实时账单，可能是不准确的、会发生改变，这时会标记该字段为 true。 若为 false，表示该账单即最终的账单。
channel	string	消息渠道。枚举值： whatsapp, sms, voice, email。
wabaId	string	WABA ID。当 channel 为 whatsapp 时包含该字段。
regionCode	string	消息发往的地区，二位字母国家或地区代码。
costItems[].cost	double	消耗金额，单位 USD
costItems[].quantity	integer	计费条数
costItems[].unitPrice	double	平均单价
costItems[].conversationOriginType	string	WhatsApp 会话类别。仅当 channel 为 whatsapp 时包含该字段。 枚举值：authentication, authentication_international, marketing, utility, service。