Get costs overview for the organization. Currently unavailable in self-hosted ECE.
Auth
Deprecated
EXPERIMENTAL (it may change in future versions): Retrieves an overview of the costs by organization ID.
-
organization_id
string
required
-
Identifier for the organization
-
from
string
-
A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.
-
to
string
-
A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.
Top-level cost overview for the organization
-
costs
object
required
-
Costs overview for an organization. All of the costs, credits, trials are expressed in Elastic Consumption Unit (ECU).
-
-
total
number · format: double
required
-
Total costs
-
dimensions
object[]
required
-
A collection of billing details by dimension.
-
-
type
enum
required
-
The type of the billing dimension
-
Values:
capacity
data_in
data_internode
data_out
storage_api
storage_bytes
-
cost
number · format: double
required
-
The cost of the billing dimension
-
trials
number · format: double
required
-
Trial costs for the organization
-
hourly_rate
number · format: double
required
-
Hourly rate applied.
-
balance
object
-
The available balance for an organization
-
-
available
number · format: double
required
-
Available balance
-
remaining
number · format: double
required
-
Remaining balance
-
line_items
object[]
required
-
A collection of order line items for for an organization
-
-
id
string
required
-
Line Item ID
-
ecu_quantity
number · format: double
required
-
Original Elastic Consumption Unit (ECU) quantity
-
ecu_balance
number · format: double
required
-
Elastic Consumption Unit (ECU) Balance
-
start
string · format: date-time
required
-
Start of the line item's validity
-
end
string · format: date-time
required
-
Expiration of the line item
The specified date range is invalid. (code: costs.invalid_date_range)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
The current user does not have access to the requested organization. (code: organization.invalid_access)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
Organization not found. (code: organization.not_found)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
An error occurred when fetching an overview of the costs for the organization. (code: billing_service.failed_request)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields