名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点，`content` 对象是一个信封。Cloud Manager 将 `status` 字段添加到响应正文。	`false`
backupJobsEnabledOnly	布尔	Optional	指示是否从响应中排除未启用备份数据库的守护进程的标志。将其设置为`false`以包含将`backupJobsEnabled`标志设置为`false`的守护进程配置。	`true`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

如果将查询元素envelope设置为true ，则响应将由content对象包装。

HTTP 响应返回一个 JSON document，其中包含以下对象：

名称

类型

说明

amountBilledCents

数字

此发票的账单金额，计算公式为subtotalCents + salesTaxCents - startupBalanceCents

amountPaidCents

数字

为此发票支付的金额。

created

字符串

创建此发票时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。

creditsCents

数字

MongoDB 存入的金额，以美分为单位。

endDate

字符串

此发票的计费周期结束时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。

groupId

字符串

与发票关联的项目的唯一标识符。 不会出现在所有发票上。

id

字符串

此发票的唯一标识符。

lineItems

对象数组

发票中的行项目。此信息也可在Cloud Manager用户界面“发票”页面的Usage Details部分找到。

大量中的每个对象都包含以下字段：

clusterName：产生费用的集群的名称。
created：将行项目过帐到发票时的 ISO 8601 日期和时间格式的时间戳（以 UTC 为单位）。
endDate：采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳，其中订单项的适用时间段结束。
discountCents：折扣金额，以美分为单位。在适用时显示。
groupId：与行项目关联的项目的ID 。
note：有关行项目的注释。
percentDiscount：折扣百分比。在适用时显示。
quantity：行项目的单位数（例如GB或小时）。
replicaSetName：与行项目关联的副本集的名称。
sku：行项目的描述。这可以是实例类型、支持费用、高级安全性等。
startDate：采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳，其中订单项的应用时间段开始于该时间戳。
totalPriceCents：订单项的总价，以美分为单位。等于
unitPriceDollars * quantity * 100
unitPriceDollars：商品的成本，以美元为单位。

links

对象数组

指向子资源和/或相关资源的一个或多个链接。URL 之间的关系类型在 Web 链接规范中进行了解释。

orgId

字符串

收到此发票的组织的唯一标识符。

payments

对象数组

应用于发票的付款。 payments大量中的对象包括以下字段：

amountBilledCents：发票金额，以美分为单位。
amountPaidCents：客户支付的金额，以美分为单位。
created：记录付款日期的 ISO 8601 日期和时间（UTC 时间）格式的时间戳。
id：付款的唯一标识符。
salesTaxCents：已付销售税金额，以美分为单位。
statusName：付款状态。
- CANCELLED：付款已取消。
- FAILED：尝试从信用收费失败。
- FORGIVEN：付款已创建，但随后被免除。
- NEW：付款已创建，但尚未尝试从信用收费。
- PAID：付款成功。
subtotalCents：所有正发票行项目的总和，以美分为单位。
updated：对象上次更新的时间戳，采用 ISO 8601 日期和 UTC 时间格式。

refunds

对象数组

发票退款。 refunds数组中的对象包括以下字段：

amountCents：退款金额，以美分为单位。
created：记录退款日期的 ISO 8601 日期和时间（UTC 时间）格式的时间戳。
reason：退款原因。
paymentId：付款的唯一标识符。

salesTaxCents

数字

对subtotalCents征收的税额。

startDate

字符串

此发票开始日期的 ISO 8601 日期和时间（UTC 时间）格式的时间戳。

statusName

字符串

此发票的状态。接受的值为：

CLOSED：订阅周期的所有费用均已确定，余额大于零，尚未向客户收费。
FAILED：尝试从信用收取应付金额失败。
FORGIVEN：已向客户收费，但费用已被免除。
FREE：金额为零，因此不会向客户收取费用。
PAID：资金已转至MongoDB, Inc.
PENDING：包括当前订阅周期的费用。处于这种状态的客户不应拥有多张发票。
PREPAID：客户使用的是预付费计划，因此无需向客户付费。

subtotalCents

数字

所有正发票行项目的总和（以美元美分为单位）。

updated

字符串

上次更新发票时采用 ISO 8601 日期和时间（UTC 时间）格式的时间戳。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/pending

响应示例

注意

在以下示例响应中，为便于查看， lineItems数组已被截断。

{
  "amountBilledCents" : 0,
  "amountPaidCents" : 0,
  "created" : "2018-06-01T04:05:10Z",
  "endDate" : "2018-07-01T00:00:00Z",
  "id" : "{INVOICE-ID}",
  "lineItems" : [ {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-19T04:06:14Z",
    "endDate" : "2018-06-19T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 12.0,
    "replicaSetName": "rs0",
    "sku" : "CLOUD_MANAGER_BASIC",
    "startDate" : "2018-06-18T00:00:00Z",
    "totalPriceCents" : 31,
    "unitPriceDollars" : 0.026
  },
  ... ,
  {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-06-19T04:06:14Z",
    "endDate" : "2018-06-19T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 1.0,
    "replicaSetName": "rs0",
    "sku" : "BACKUP_STORAGE",
    "startDate" : "2018-06-18T00:00:00Z",
    "totalPriceCents" : 4,
    "unitPriceDollars" : 0.0351
  } ],
  "links" : [ {
    "href" : "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
    "rel" : "http://mms.mongodb.com/org"
  }, {
    "href" : "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
    "rel" : "self"
  } ],
  "orgId" : "{ORG-ID}",
  "payments" : [ ],
  "refunds" : [ ],
  "salesTaxCents" : 0,
  "startDate" : "2018-06-01T00:00:00Z",
  "startingBalanceCents" : 0,
  "statusName" : "PENDING",
  "subtotalCents" : 0,
  "updated" : "2018-06-01T04:05:10Z"
}

后退

获取一个

来年