获取一张组织发票
2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
ORG-ID | 字符串 | 组织的唯一标识符。 |
INVOICE-ID | 字符串 | 发票的唯一标识符。 费用通常在第二天公布。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回结果列表的端点， | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false以包含将backupJobsEnabled标志设置为false的守护进程配置。 | true |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
如果将查询元素envelope设置为true ，则响应将由content对象包装。
HTTP 响应返回一个 JSON document，其中包含以下对象：
名称 | 类型 | 说明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amountBilledCents | 数字 | 此发票的账单金额，计算公式为subtotalCents + salesTaxCents - startupBalanceCents | ||||||||||||||||||||||||||||||
amountPaidCents | 数字 | 为此发票支付的金额。 | ||||||||||||||||||||||||||||||
created | 字符串 | ISO8601 格式的时间戳 创建此发票时的日期和时间格式（ UTC 格式）。 | ||||||||||||||||||||||||||||||
creditsCents | 数字 | MongoDB 存入的金额，以美分为单位。 | ||||||||||||||||||||||||||||||
endDate | 字符串 | ISO8601 格式的时间戳 此发票的计费周期结束时的日期和时间格式（ UTC 格式）。 | ||||||||||||||||||||||||||||||
groupId | 字符串 | 与发票关联的项目的唯一标识符。 不会出现在所有发票上。 | ||||||||||||||||||||||||||||||
id | 字符串 | 此发票的唯一标识符。 | ||||||||||||||||||||||||||||||
lineItems | 对象数组 | 发票中的行项目。 此信息也可在Cloud Manager用户界面“发票”页面的 Usage Details部分找到。 大量中的每个对象都包含以下字段：
| ||||||||||||||||||||||||||||||
links | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 URL 之间的关系类型在 Web 链接规范 中进行了解释 。 | ||||||||||||||||||||||||||||||
orgId | 字符串 | 收到此发票的组织的唯一标识符。 | ||||||||||||||||||||||||||||||
payments | 对象数组 | 应用于发票的付款。
| ||||||||||||||||||||||||||||||
refunds | 对象数组 | 发票退款。
| ||||||||||||||||||||||||||||||
salesTaxCents | 数字 | 对subtotalCents征收的税额。 | ||||||||||||||||||||||||||||||
startDate | 字符串 | ISO8601 格式的时间戳 此发票开始日期的日期和时间格式（ UTC 格式）。 | ||||||||||||||||||||||||||||||
statusName | 字符串 | 此发票的状态。 接受的值为：
| ||||||||||||||||||||||||||||||
subtotalCents | 数字 | 所有正发票行项目的总和（以美元美分为单位）。 | ||||||||||||||||||||||||||||||
updated | 字符串 | ISO8601 格式的时间戳 上次更新发票的日期和时间格式（ 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/{INVOICE-ID}"
响应示例
注意
在以下示例响应中，为便于查看， lineItems数组已被截断。
{ "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-04-01T06:14:31Z", "endDate" : "2018-05-01T00:00:00Z", "id" : "{INVOICE-ID}", "lineItems" : [ { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-05-01T04:05:31Z", "endDate" : "2018-05-01T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-30T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-30T04:05:19Z", "endDate" : "2018-04-30T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-29T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 }, ... , { "clusterName" : "{CLUSTER-NAME}", "created" : "2018-04-02T06:05:07Z", "endDate" : "2018-04-02T00:00:00Z", "groupId" : "{PROJECT-ID}", "quantity" : 72.0, "replicaSetName": "rs0", "sku" : "CLOUD_MANAGER_BASIC", "startDate" : "2018-04-01T00:00:00Z", "totalPriceCents" : 0, "unitPriceDollars" : 0.0 } ], "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}", "rel" : "http://mms.mongodb.com/org" }, { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}", "rel" : "self" } ], "orgId" : "{ORG-ID}", "payments" : [ { "amountBilledCents" : 240, "amountPaidCents" : 240, "created" : "2018-05-01T04:05:14Z", "id" : "{PAYMENT-ID}", "salesTaxCents" : 19, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z" } ], "refunds" : [ ], "salesTaxCents" : 19, "startDate" : "2018-04-01T00:00:00Z", "startingBalanceCents" : 0, "statusName" : "PAID", "subtotalCents" : 221, "updated" : "2018-05-01T07:00:46Z"