Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
Auth
Deprecated
Retrieves the costs associated with all deployments 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 activity. Defaults to start of current month.
-
to
string
-
A datetime for the end of the desired range for which to fetch activity. Defaults to the current date.
The costs associated to a set of products
-
total_cost
number · format: double
required
-
Total cost for all deployments
-
deployments
object[]
required
-
Costs of the list of deployments
-
-
deployment_id
string
required
-
Elasticsearch deployment id
-
deployment_name
string
required
-
Elasticsearch deployment name
-
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
-
hourly_rate
number · format: double
required
-
Price per hour
-
period
object
-
Period
-
-
start
string · format: date-time
required
-
Start
-
end
string · format: date-time
required
-
End
Invalid date range specified. (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 the costs associated with all deployments 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