Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / /

組織の保留中の請求書を取得する

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

GET /orgs/{ORG-ID}/invoices/pending
名前
タイプ
説明
ORG-ID
string
組織の一意の識別子です。

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope : trueを設定します。

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

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

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

クエリ要素envelopetrueに設定すると、応答は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セクションにも記載されています。

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

Item
説明
clusterName
料金を発生させたクラスターの名前
created
ISO8601 のタイムスタンプ 明細項目が請求書に請求されたときの UTC 形式の日付と時刻形式。
endDate
ISO8601 のタイムスタンプ 行項目が適用される期間が終了したときの UTC の日付と時刻形式。
discountCents
割引された金額(USD セント単位)。 該当する場合は が表示されます。
groupId
行項目が関連付けられているプロジェクトの ID。
note
行項目に注意してください。
percentDiscount
割引率。 該当する場合は が表示されます。
quantity
行項目の単位数(例: GB、 時間など)。
replicaSetName
行項目が関連付けられているレプリカセットの名前。
sku
行項目の説明。 これは、インスタンスの種類、サポート料金、高度なセキュリティなどです。
startDate
ISO8601 のタイムスタンプ 行項目が適用される期間が開始されたときの UTC 形式の日付と時刻形式。
totalPriceCents

明細項目の合計価格(USD セント単位)。 と等しい

unitPriceDollars * quantity * 100
unitPriceDollars
アイテムのコスト(ドル単位)。
links
オブジェクト配列

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

orgId
string
この請求書を受信した組織の一意の識別子。
payments
オブジェクト配列

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

フィールド
説明
amountBilledCents
請求書の金額(USD セント単位)。
amountPaidCents
カスタマーが支払った金額(USD セント単位)。
created
ISO8601 のタイムスタンプ 支払いが記録された日付の UTC 形式の日時。
id
支払いの一意の識別子。
salesTaxCents
支払られた売上税金の金額(USD セント単位)。
statusName

支払い状況。

ステータス
説明
CANCELLED
支払いがキャンセルされました。
FAILED
クレジットカードへの請求は失敗しました。
FORGIVEN
支払いが作成されましたが、その後許可されました。
NEW
支払いは作成されましたが、クレジットカードに請求は行われていません。
PAID
支払いが成功しました。
subtotalCents
すべての正の請求書の明細項目の合計(USD セント単位)。
updated
ISO8601 のタイムスタンプ オブジェクトが最後にアップデートされた日時の UTC 形式。
refunds
オブジェクト配列

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

フィールド
説明
amountCents
返金額(USD セント単位)。
created
ISO8601 のタイムスタンプ 返金が記録された日付の UTC での日時形式。
reason
返金の理由。
paymentId
支払いの一意の識別子。
salesTaxCents
数値
subtotalCentsに課される税金の額。
startDate
string
ISO8601 のタイムスタンプ この請求書の開始日の UTC での日付と時刻形式。
statusName
string

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

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

戻る

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