Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
Auth
Deprecated
EXPERIMENTAL (it may change in future versions): Retrieves the itemized costs for the organization.
-
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.
The costs associated to a set of items
-
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
-
data_transfer_and_storage
object[]
required
-
List of the detailed costs associated to the Data Transfer and Storage (DTS) dimensions
-
-
cost
number · format: double
required
-
Costs associated to the Data Transfer and Storage (DTS) dimensions for an organization
-
name
string
required
-
DTS dimension name
-
quantity
object
required
-
DTS quantity
-
-
value
integer · format: int64
required
-
Raw quantity
-
formatted_value
string
required
-
Quantity in human readable format
-
rate
object
required
-
DTS Rate
-
-
value
number · format: double
required
-
Raw rate
-
formatted_value
string
required
-
Rate in human readable format
-
sku
string
required
-
DTS dimension Stock Keeping Unit (SKU)
-
type
string
required
-
Type of the DTS dimension usage
-
resources
object[]
required
-
Costs of the list of resources
-
-
hours
integer · format: int64
required
-
Resource usage in hours
-
instance_count
integer · format: int32
required
-
Number of instances
-
period
object
required
-
Period
-
-
start
string · format: date-time
required
-
Start
-
end
string · format: date-time
required
-
End
-
kind
enum
required
-
Kind of resource
-
Values:
elasticsearch
kibana
apm
integrations_server
appsearch
enterprise_search
-
price
number · format: double
required
-
Resource price
-
price_per_hour
number · format: double
required
-
Price per hour
-
name
string
required
-
Resource name
-
sku
string
required
-
Stock Keeping Unit (SKU)
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
Error fetching the itemized 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