AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

1 つの組織の請求書を取得

ベース URL: https://cloud.mongodb.com/api/public/v1.0

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 レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope : true を設定します。

結果のリストを返すエンドポイントの場合、 contentオブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体にstatusフィールドを追加します。

false

backupJobsEnabledOnly

ブール値

任意

データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。

true

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

クエリ要素envelopeをtrueに設定すると、応答はcontentオブジェクトによってラップされます。

HTTP レスポンスでは、次のオブジェクトを含む JSON document が返されます。

名前
タイプ
説明

amountBilledCents

数値

この請求書の請求額( subtotalCents + salesTaxCents - startingBalanceCentsとして計算)

amountPaidCents

数値

この請求書の支払額。

created

string

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

creditsCents

数値

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

endDate

string

この請求書の請求期間が終了した時点のISO 8601形式の日付と時刻(UTC)。

groupId

string

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

id

string

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

lineItems

オブジェクト配列

請求書の明細項目。 この情報は、Cloud Manager UI の請求書ページの [ Usage Detailsセクションにも記載されています。

配列内の各オブジェクトには、次のフィールドが含まれています。

  • clusterName: 請求が発生したクラスター名。

  • created請求書に明細項目が書き込まれた日時( UTC )のタイムスタンプ( ISO 形式)。8601

  • endDateこの明細項目が適用される期間が終了した時点の、ISO 8601形式のUTCでの日付と時刻のタイムスタンプ。

  • discountCents: 割引額、米ドルセント単位。該当する場合に表示されます。

  • groupId: ラインアイテムが関連付けられているプロジェクトのID。

  • note:行項目に関する注意事項

  • percentDiscount: 割引率。該当する場合に表示されます。

  • quantity:明細行項目の単位数(例:GB または時間)。

  • replicaSetName: ラインアイテムが関連付けられているレプリカセットの名前。

  • sku:明細項目の説明。これは、インスタンスタイプ、サポート料金、高度なセキュリティなどです。

  • startDate: Timestamp in ISO 8601 date and time format in UTC when the period for which the line item applies began.

  • totalPriceCents: 品目ごとの合計価格(米ドルセント単位)。と等しい

    unitPriceDollars * quantity * 100
  • unitPriceDollars: 品目のコスト、米ドル単位です。

links

オブジェクト配列

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

orgId

string

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

payments

オブジェクト配列

請求書に適用された支払い。 payments配列内のオブジェクトには次のフィールドが含まれます。

  • amountBilledCents:請求書の金額(USD セント単位)

  • amountPaidCents: カスタマーが支払った金額。単位は米ドルセント。

  • created: 支払い記録の日時の ISO 8601 形式のタイムスタンプ(UTC)。

  • id: 支払いの一意の識別子。

  • salesTaxCents: 支払された詟販税の額(USD セント単位)

  • statusName: 支払いの状態。

    • CANCELLED: 支払いがキャンセルされました。

    • FAILED: クレジットカードへの請求が失敗しました。

    • FORGIVEN: 支払いが作成されましたが、その後に免除されました。

    • NEW: 支払いは作成されましたが、クレジット カードに請求する試みは行われていません。

    • PAID: お支払いは成功させる。

  • subtotalCents: 正の請求書行項目の合計、米ドルセント単位。

  • updatedオブジェクトが最後に更新されたときの ISO 8601 の日付と時刻形式の UTC タイムスタンプ。

refunds

オブジェクト配列

請求書に対して発行された返金。 refunds配列内のオブジェクトには次のフィールドが含まれます。

  • amountCents: 米ドルセント単位での返金額。

  • created返金が記録された日付のタイムスタンプ(ISO 8601 形式、UTC)。

  • reason:払い戻しの理由。

  • paymentId: 支払いの一意の識別子。

salesTaxCents

数値

subtotalCentsに課される税金の額。

startDate

string

この請求書の開始日の ISO 8601 の日付と時刻形式の UTC タイムスタンプ。

statusName

string

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

  • CLOSED: サブスクリプションサイクルのすべての請求額が確定しました。残高がゼロより大きく、まだカスタマーに請求されていません。

  • FAILED: 未払金額に対するクレジットカードへの請求が失敗しました。

  • FORGIVEN: カスタマーに請求が行われていますが、その請求は免除されています。

  • FREE: 金額がゼロになりましたので、カスタマーに請求されません。

  • PAID: 資金は MongoDB, Inc. へ送金されました。

  • PENDING: 現在のサブスクリプション サイクルの料金が含まれます。カスタマーは、この状態で複数の請求書を持つべきではありません。

  • PREPAID: カスタマーはプリペイドプランを利用しているため、カスタマーには請求されません。

subtotalCents

数値

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

updated

string

請求書が最後に更新されたときの 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/{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"