1 つの組織の請求書を取得
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
ORG-ID | string | 組織の一意の識別子です。 |
INVOICE-ID | string | 請求書のユニーク識別子。 料金は通常翌日に表示されます。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
クエリ要素envelopeをtrueに設定すると、応答はcontentオブジェクトによってラップされます。
HTTP レスポンスでは、次のオブジェクトを含む JSON document が返されます。
名前 | タイプ | 説明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amountBilledCents | 数値 | この請求書の請求額（ subtotalCents + salesTaxCents - startingBalanceCentsとして計算） | ||||||||||||||||||||||||||||||
amountPaidCents | 数値 | この請求書の支払額。 | ||||||||||||||||||||||||||||||
created | string | ISO8601 のタイムスタンプ この請求書が作成されたときの UTC の日付と時刻形式。 | ||||||||||||||||||||||||||||||
creditsCents | 数値 | MongoDB によってクレジットされた金額（USD セント単位）。 | ||||||||||||||||||||||||||||||
endDate | string | ISO8601 のタイムスタンプ この請求書の請求期間が終了したときの日付と時刻形式（ UTC） 。 | ||||||||||||||||||||||||||||||
groupId | string | 請求書が関連付けられているプロジェクトの一意の識別子。 すべての請求書に表示されるわけではありません。 | ||||||||||||||||||||||||||||||
id | string | この請求書のユニーク識別子。 | ||||||||||||||||||||||||||||||
lineItems | オブジェクト配列 | 請求書の明細項目。 この情報は、Cloud Manager UI の請求書ページの [ Usage Detailsセクションにも記載されています。 配列内の各オブジェクトには、次のフィールドが含まれています。
| ||||||||||||||||||||||||||||||
links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 URL 間の関係タイプについては、 Web リンク仕様 で説明されています。 。 | ||||||||||||||||||||||||||||||
orgId | string | この請求書を受信した組織の一意の識別子。 | ||||||||||||||||||||||||||||||
payments | オブジェクト配列 | 請求書に適用された支払い。
| ||||||||||||||||||||||||||||||
refunds | オブジェクト配列 | 請求書に対して発行された返金。
| ||||||||||||||||||||||||||||||
salesTaxCents | 数値 | subtotalCentsに課される税金の額。 | ||||||||||||||||||||||||||||||
startDate | string | ISO8601 のタイムスタンプ この請求書の開始日の UTC での日付と時刻形式。 | ||||||||||||||||||||||||||||||
statusName | string | この請求書の状態。 指定できる値は以下のとおりです。
| ||||||||||||||||||||||||||||||
subtotalCents | 数値 | すべての正の請求書の明細項目を USD セント単位で合計します。 | ||||||||||||||||||||||||||||||
updated | string | 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"