名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで `envelope : true` を設定します。結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

result配列内の各ドキュメントは 1 件の請求書を表します。料金は通常翌日に表示されます。

名前

タイプ

説明

amountBilledCents

数値

この請求書の請求額は、 subtotalCents + salesTaxCents - startingBalanceCentsとして計算されます。

amountPaidCents

数値

この請求書の支払額（USD セント単位）。

created

string

Timestamp in ISO 8601 date and time format in UTC when this invoice was created.

creditsCents

数値

MongoDB によってクレジットされた金額（USD セント単位）。

endDate

string

Timestamp in ISO 8601 date and time format in UTC when the billing period for this invoice ended.

id

string

この請求書のユニーク識別子。

links

オブジェクト配列

サブリソースや関連リソースへの 1 つ以上のリンク。URL 間の関係タイプについては、Web リンク仕様で説明されています。

groupId

string

請求書が関連付けられているプロジェクトの一意の識別子。 すべての請求書に表示されるわけではありません。

orgId

string

この請求書を受信した組織の一意の識別子。

salesTaxCents

数値

subtotalCentsに課される税金の額。

startDate

string

Timestamp in ISO 8601 date and time format in UTC of the starting date for this invoice.

statusName

string

この請求書の状態。指定できる値は以下のとおりです。

ステータス	説明
`CLOSED`	サブスクライブサイクルのすべての料金は確定され、残高は 0 より超えており、カスタマーはまだ請求されていません。
`FAILED`	クレジットカードに未払い金額を請求しようとすると失敗しました。
`FORGIVEN`	カスタマーに請求が行われていますが、その請求は許可されています。
`FREE`	金額はゼロであることが確認され、カスタマーは料金を請求されません。
`PAID`	金額は MongoDB, Inc. に転送されました。
`PENDING`	現在のサブスクライブサイクルの料金が含まれます。この状態では、カスタマーは複数の請求書を持つことはできません。
`PREPAID`	カスタマーはプリペイドプランに登録されているため、料金は請求されません。

subtotalCents

数値

すべての正の請求書の明細項目を USD セント単位で合計します。

updated

string

Timestamp in ISO 8601 date and time format in UTC when the invoice was last updated.

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/?pretty=true"

応答例

{
   "links" : [ {
     "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/?pretty=true&pageNum=1&itemsPerPage=100",
     "rel" : "self"
   } ],
   "results" : [ {
     "amountBilledCents" : 0,
     "amountPaidCents" : 0,
     "created" : "2018-06-01T04:05:10Z",
     "endDate" : "2018-07-01T00:00:00Z",
     "id" : "{INVOICE-ID}",
     "links" : [ {
       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
       "rel" : "self"
     } ],
     "orgId" : "{ORG-ID}",
     "salesTaxCents" : 0,
     "startDate" : "2018-06-01T00:00:00Z",
     "startingBalanceCents" : 0,
     "statusName" : "PENDING",
     "subtotalCents" : 0,
     "updated" : "2018-06-01T04:05:10Z"
   }, {
     "amountBilledCents" : 726,
     "amountPaidCents" : 726,
     "created" : "2018-02-01T06:05:04Z",
     "endDate" : "2018-03-01T00:00:00Z",
     "id" : "{INVOICE-ID}",
     "links" : [ {
       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
       "rel" : "self"
     } ],
     "orgId" : "{ORG-ID}",
     "salesTaxCents" : 57,
     "startDate" : "2018-02-01T00:00:00Z",
     "startingBalanceCents" : 0,
     "statusName" : "PAID",
     "subtotalCents" : 669,
     "updated" : "2018-03-01T07:00:54Z"
   } ],
   "totalCount" : 16
}

戻る

請求書

1 つの取得

1 つの組織のすべての請求書を取得

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

リクエストの例

応答例

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ