確定済み課金情報の取得 (GET /v1/charges/YYYY/MM)
指定した期間と条件に合致する各月の確定済み課金情報を取得する。
取得する請求対象月は、URIの「YYYY」には4桁の西暦、「MM」には2桁の月で指定する。2015年3月分の情報を検索対象とする場合には、「/v1/charges/2015/03」をURIとする。
Request Headers
X-Auth-Token:
認証トークンIDを指定する。
Data Type | Cardinality |
---|---|
String | 1..1 |
Request Parameter
検索条件を以下のキーで指定できる。各キーは完全一致で検索される。
domain_id
絞込条件にドメインIDを指定する。省略時には認証トークンから得られるドメインIDが使用される。
Data Type | Cardinality |
---|---|
String | 0..1 |
project_id
絞込条件にプロジェクトIDを指定する。指定時には、プロジェクト毎に集計された課金情報を返却する。
Data Type | Cardinality |
---|---|
String | 0..1 |
product_id
絞込条件に商品IDを指定する。
Data Type | Cardinality |
---|---|
String | 0..1 |
service_id
絞込条件にサービスIDを指定する。
Data Type | Cardinality |
---|---|
String | 0..1 |
region_id
絞込条件にリソースが配備されているリージョンのIDを指定する。
Data Type | Cardinality |
---|---|
String | 0..1 |
Response Headers
ステータス
リクエストのステータスを返却する。
以下もしくは「API共通エラー情報」へ記載のステータス。
- 200:
- 正常終了
Data Type | Cardinality |
---|---|
Int | 1..1 |
Content-Type
application/json
Data Type | Cardinality |
---|---|
String | 1..1 |
Response Elements
last_modified
本データの最終更新時刻(UTC)。
ISO-8601の下記形式とする。
YYYY-MM-DD'T'HH:mm:ss.sss
タイムゾーンは指定しない
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
billing_month
請求の対象となる月。
"YYYY-MM"形式とする。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
sub_div
- ドメイン毎:
- "D"
- プロジェクト毎:
- "P"
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
domain_id
請求対象となるドメインのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
project_id
請求対象となるプロジェクトのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
line_seq
明細上の行番号。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
detail_div
- 定額:
- 01
- 一時:
- 02
- 従量:
- 03
- 割引:
- 04
- 小計:
- 05
- 調整:
- 07
- 合計:
- 08
- コメント:
- 99
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
reseller_id
契約しているリセラーのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
product_id
請求対象となった商品のID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
region_id
請求対象となったリージョンのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
service_provider_id
商品のサービスプロバイダのID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
product_name
言語毎の商品名が入ったArray。
- "lang"(String):
- 言語コード(ISO639-1)
- "value"(String):
- 商品名
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Array | 1..1 | None | None |
comment
言語毎の備考情報が入ったArray。
- "lang"(String):
- 言語コード(ISO639-1)
- "value"(String):
- 備考
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Array | 1..1 | None | None |
usage
請求対象となった使用量
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
unit_price
商品の単価
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
unit_name
言語毎の使用量の単位が入ったArray。
- "lang"(String):
- 言語コード(ISO639-1)
- "value"(String):
- 単位を表す文字列
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Array | 1..1 | None | None |
charge
課金額
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Number | 1..1 | None | None |
currency_code
課金額の通貨コード(ISO4217)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | None | None |
Example of Request
GET /v1/charges/2014/06
HTTP/1.1
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4..."
Example of Response
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"last_modified" : "2014-07-01T12:00:00.000",
"billing_month" : "2014-06",
"sub_div" : "D",
"domain_id" : "ca-1a2b3c4d5e",
"project_id" : "capj-1a2b3c4d5e",
"line_seq" : 1,
"detail_div" : "01",
"reseller_id" : "ResellerId",
"product_id" : "P01C010001",
"region_id" : "jp-east-1",
"service_provider_id" : "fujitsu.com",
"service_id" : "compute",
"product_name" : [
{ "lang" : "ja", "value" : "商品名" },
{ "lang" : "en", "value" : "Product Name" },
{ "lang" : "de", "value" : "Produktname" }
],
"comment" : [
{ "lang" : "ja", "value" : "備考" },
{ "lang" : "en", "value" : "Notes" },
{ "lang" : "de", "value" : "Bemerkungen" }
],
"usage" : 400,
"unit_price" : 100,
"unit_name" : [
{ "lang" : "ja", "value" : "GB" },
{ "lang" : "en", "value" : "GB" },
{ "lang" : "de", "value" : "GB" }
],
"charge" : 40000,
"currency_code" : "JPY"
},
{
"last_modified" : "2014-07-01T12:00:00.000",
"billing_month" : "2014-06",
"sub_div" : "D",
"domain_id" : "ca-1a2b3c4d5e",
"project_id" : "capj-1a2b3c4d5e",
"line_seq" : 2,
"detail_div" : "01",
"reseller_id" : "ResellerId",
"product_id" : "P01C010001",
"region_id" : "uk-1",
"service_provider_id" : "fujitsu.com",
"service_id" : "compute",
"product_name" : [
{ "lang" : "ja", "value" : "商品名" },
{ "lang" : "en", "value" : "Product Name" },
{ "lang" : "de", "value" : "Produktname" }
],
"comment" : [
{ "lang" : "ja", "value" : "備考" },
{ "lang" : "en", "value" : "Notes" },
{ "lang" : "de", "value" : "Bemerkungen" }
],
"usage" : 200,
"unit_price" : 100,
"unit_name" : [
{ "lang" : "ja", "value" : "GB" },
{ "lang" : "en", "value" : "GB" },
{ "lang" : "de", "value" : "GB" }
],
"charge" : 20000,
"currency_code" : "JPY"
}
]