AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 费用与成本 开发参考 API参考指南 API目录 财务账单 QuerySettleBill - 结算账单查询服务

QuerySettleBill - 结算账单查询服务

更新时间：
我的收藏

查询用户某个账期内结算账单。支持账单条目超过50000条的国内账号。

接口说明

  • 当月数据查询结果仅供参考，不作为对账依据；当月最终账单在次月 2 日 12 点后支持查看/导出（月中会发生包括但不限于以下少数场景：延迟出账，退款，调账，欠费核销等）。

  • 账单数据相对于实际费用消耗延迟 5 小时更新。

  • 账单数据中对于历史账期“未结清”状态的账单，还款后延迟 5 个小时更新为已结清；对于当月“未结清”状态的账单，还款后于次月 2 日 12 点出账时更新为已结清。

  • 当前 API 支持优雅退避，请求速率为 600/60(s)。

  • 单用户限流 10 笔/秒，如遇超时，请重试。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bssapi:QuerySettleBill

get

*全部资源

*
bssapi:ProductCode
bssapi:ProductType
 无

请求参数

名称

类型

必填

描述

示例值
BillingCycle

string

是

账期，YYYY-MM。

2018-07
Type

string

否

类型。取值：

  • SubscriptionOrder 预付费订单

  • PayAsYouGoBill 后付费账单

  • Refund 退款账单

  • Adjustment 调账账单

SubscriptionOrder
ProductCode

string

否

产品代码。

rds
ProductType

string

否

产品类型。

rds
SubscriptionType

string

否

订阅类型。取值：

  • Subscription 预付费

  • PayAsYouGo 后付费

说明

必须和 ProductCode 参数一起使用。

Subscription
IsHideZeroCharge

boolean

否

根据原价（PretaxGrossAmount）是否为 0 做过滤，默认为否（兼容现有逻辑）。

  • true：是。

  • false：否。

true
NextToken

string

否

用来标记当前开始读取的位置，置空表示从头开始。

CAESEgoQCg4KCmdtdF9jcmVhdGUEARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U
MaxResults

integer

否

本次读取的最大数据记录数量。默认值：20，最大值：300。

20
BillOwnerId

integer

否

资源归属账号的 ID，资源归属账号是实际使用资源的账号。

123
RecordID

string

否

订单号、账单号。

12233

返回参数

名称

类型

描述

示例值

object

Code

string

状态码

Success
Message

string

错误信息。

Successful!
RequestId

string

请求 ID。

AE3F4057-DFC9-4B81-8858-F620651010C9
Success

boolean

是否成功。

true
Data

object

返回数据。

NextToken

string

用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。

CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U
BillingCycle

string

账期，YYYY－MM。

2020-02
MaxResults

integer

本次请求所返回的最大记录条数。

20
AccountID

string

账号 ID。

185xxxxx489
TotalCount

integer

总记录数。

200
AccountName

string

账号。

test@test.aliyunid.com
Items

object

Item

array<object>

账单详情。

object

Status

string

支付状态。取值：

  • PayFinish：已支付

  • PayUnclear：未结清

  • PayUnsettle：未结算

  • NoSettle：免结算

PayFinish
RoundDownDiscount

string

抹零优惠。

0
Item

string

账单类型：

  • Subscription

  • OrderPayAsYouGoBill

  • Refund

  • Adjustment

Subscription
Currency

string

币种。

  • CNY

  • USD

  • JPY

CNY
BillAccountName

string

账单所属账号名称。

test@test.aliyunid.com
DeductedByCashCoupons

number

代金券抵扣。

0
SubscriptionType

string

订阅类型。取值：

  • Subscription

  • PayAsYouGo

PayAsYouGo
UsageStartTime

string

账单开始时间。

2020-03-11 07:00:00
BizType

string

业务类型。

trusteeship
UsageEndTime

string

账单结束时间。

2020-03-11 08:00:00
DeductedByCoupons

number

优惠券抵扣。

0
SubOrderId

string

该条账单对应的订单明细 ID。

325345254353
OutstandingAmount

number

未结清金额。

0
PaymentTime

string

订单支付时间。

2020-03-11 08:00:00
PipCode

string

产品 Code，与费用中心账单产品 Code 一致

rds
PretaxAmount

number

应付金额。

100
CommodityCode

string

商品 Code，与费用中心产品明细 Code 一致

rds
ProductName

string

产品名称。

云数据库RDS
RecordID

string

订单号、账单号。

2020xxxx5912
AdjustAmount

number

信用额度退款抵扣。

0
ProductDetail

string

产品明细。

关系型数据库RDS（包月）
OwnerID

string

子账号 AccountID（多账号代付场景）。

3532535235
DeductedByPrepaidCard

number

储值卡抵扣。

0
BillAccountID

string

账单所属账号 ID。

185xxxxx489
PaymentAmount

number

现金支付（包含信用额度退款抵扣）。

0
InvoiceDiscount

number

优惠金额。

0
ProductType

string

产品类型。

rds
PretaxGrossAmount

number

原始金额。

0
CashAmount

number

现金支付（不包含信用额度退款抵扣）。

0
ProductCode

string

产品代码。

rds

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "AE3F4057-DFC9-4B81-8858-F620651010C9",
  "Success": true,
  "Data": {
    "NextToken": "CAESEgoQCg4KCmdtdF9jcmVhdGUQARgBIkgKCQBwhGmPcAEAAAo7AzYAAAAxTDgwMDcxMjg3ZDJhNmM3ZDguTDgwMDAwMDAwMDAwMzE1MTIuTDgwMDcyZDMyZTJkYzg3N2U",
    "BillingCycle": "2020-02",
    "MaxResults": 20,
    "AccountID": "185xxxxx489",
    "TotalCount": 200,
    "AccountName": "test@test.aliyunid.com",
    "Items": {
      "Item": [
        {
          "Status": "PayFinish",
          "RoundDownDiscount": "0",
          "Item": "Subscription",
          "Currency": "CNY",
          "BillAccountName": "test@test.aliyunid.com",
          "DeductedByCashCoupons": 0,
          "SubscriptionType": "PayAsYouGo",
          "UsageStartTime": "2020-03-11 07:00:00",
          "BizType": "trusteeship",
          "UsageEndTime": "2020-03-11 08:00:00",
          "DeductedByCoupons": 0,
          "SubOrderId": "325345254353",
          "OutstandingAmount": 0,
          "PaymentTime": "2020-03-11 08:00:00",
          "PipCode": "rds",
          "PretaxAmount": 100,
          "CommodityCode": "rds",
          "ProductName": "云数据库RDS",
          "RecordID": "2020xxxx5912",
          "AdjustAmount": 0,
          "ProductDetail": "关系型数据库RDS（包月）",
          "OwnerID": "3532535235",
          "DeductedByPrepaidCard": 0,
          "BillAccountID": "185xxxxx489",
          "PaymentAmount": 0,
          "InvoiceDiscount": 0,
          "ProductType": "rds",
          "PretaxGrossAmount": 0,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：QueryAccountBill - 账号账单查询服务下一篇：QueryInstanceBill - 实例账单查询服务