Obtaining the Final billing information (GET /v1/charges/YYYY/MM)

To get the final billing information of each month in accordance with specified period and conditions.

Billing information of specific month can be obtained by specifying the 4 digits of the year as　"YYYY" and the 2 digits of the month as "MM" in URI. For example: To get billing information of 2015/03 specify " /v1/charges/2015/03" in the URI.

Request Headers

X-Auth-Token:

Specify the authentication token ID.

Data Type	Cardinality
String	1..1

Request Parameter

Refine search criteria can be specified with the following key. Each key is searched for an exact match.

domain_id

Specify the domain ID in refine search criteria. The default domain ID obtained from the authentication token is used.

Data Type	Cardinality
String	0..1

project_id

Specify the Project ID in refine search criteria. Specifying this returns the aggregated billing information of every project.

Data Type	Cardinality
String	0..1

product_id

Specify Product ID in refine search criteria.

Data Type	Cardinality
String	0..1

service_id

Specify Service ID in refine search criteria.

Data Type	Cardinality
String	0..1

region_id

Specify Region ID (where resources are deployed) in refine search criteria.

Data Type	Cardinality
String	0..1

Response Headers

Status

Returns the status of the request.

As per below or according to the status described in [Common API Error Information].

200:: Successful completion

Data Type	Cardinality
Int	1..1

Content-Type

application/json

Data Type	Cardinality
String	1..1

Response Elements

last_modified

Last modified date and time (UTC) of this data.

Displayed in ISO-8601 format as follows.

YYYY-MM-DD'T'hh:mm:ss.sss

It does not specify time zone.

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

billing_month

Billing of the required month will be displayed in below format.

"YYYY-MM".

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

sub_div

Sub division of billing. Depending on the category, the following string is returned.

Each Domain:: "D"
Each Project :: "P"

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

domain_id

Billable Domain ID.

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

project_id

Billable Project ID.

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

line_seq

Line number on the description.

Data Type	Cardinality	Parent Element	Child Element(s)
Number	1..1	None	None

detail_div

Details on the description. Depending on the category, the following string is returned.

Fixed Amount :: 01
Time Period :: 02
Usage :: 03
Discount :: 04
SubTotal :: 05
Adjust:: 07
Total :: 08
Comment :: 99

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

reseller_id

Reseller ID of the Subscriber

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

product_id

Billable Product ID

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

region_id

Billable Region ID

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

service_provider_id

Service Provider ID of the product

Data Type	Cardinality	Parent Element	Child Element(s)
String	1..1	None	None

product_name

Array containing the product name for each language.

List of each element with object type has following members.

"lang"(String) :: Language Code(ISO639-1)
"value"(String) :: Product Name

Data Type	Cardinality	Parent Element	Child Element(s)
Array	1..1	None	None

comment

Array containing remarks information for each language.

List of each element with object type has following members.

"lang"(String) :: Language Code(ISO639-1)
"value"(String) :: Remarks

Data Type	Cardinality	Parent Element	Child Element(s)
Array	1..1	None	None

usage

Billing as per Usage

Data Type	Cardinality	Parent Element	Child Element(s)
Number	1..1	None	None

unit_price

Unit price of products

Data Type	Cardinality	Parent Element	Child Element(s)
Number	1..1	None	None

unit_name

Array containing units of usage for each language.

List of each element with object type has following members.

"lang"(String) :: Language Code(ISO639-1)
"value"(String) :: String that represents the unit.

Data Type	Cardinality	Parent Element	Child Element(s)
Array	1..1	None	None

charge

Billing Amount

Data Type	Cardinality	Parent Element	Child Element(s)
Number	1..1	None	None

currency_code

Currency code of the billing amount (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" : "syouhinmei" },
    { "lang" : "en", "value" : "Product Name" },
    { "lang" : "de", "value" : "Produktname" }
  ],
  "comment" : [
    { "lang" : "ja", "value" : "bikou" },
    { "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" : "syouhinmei" },
    { "lang" : "en", "value" : "Product Name" },
    { "lang" : "de", "value" : "Produktname" }
  ],
  "comment" : [
    { "lang" : "ja", "value" : "bikou" },
    { "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"
}
]