Billing Costs Analysis
editBilling Costs Analysis
edit- Get costs overview for the organization. Currently unavailable in self-hosted ECE.
- Get charts for the organization. Currently unavailable in self-hosted ECE.
- Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
- Get charts by deployment. Currently unavailable in self-hosted ECE.
- Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
- Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
Get costs overview for the organization. Currently unavailable in self-hosted ECE.
editEXPERIMENTAL (it may change in future versions): Retrieves an overview of the costs by organization ID.
Request
editGET /api/v1/billing/costs/{organization_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the organization |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month. |
|
|
N |
A datetime for the end of the desired range for which to fetch costs. Defaults to the current date. |
Responses
edit-
200
-
Top-level cost overview for the organization
-
400
-
The specified date range is invalid. (code:
costs.invalid_date_range
)Headers
-
x-cloud-error-codes
(string
; allowed values: [costs.invalid_date_range
]) - The error codes associated with the response
-
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
Organization not found. (code:
organization.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
]) - The error codes associated with the response
-
-
500
-
An error occurred when fetching an overview of the costs for the organization. (code:
billing_service.failed_request
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.failed_request
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id} \ -H "Authorization: ApiKey $EC_API_KEY"
Get charts for the organization. Currently unavailable in self-hosted ECE.
editEXPERIMENTAL (it may change in future versions): Retrieves the usage charts for the organization.
Request
editGET /api/v1/billing/costs/{organization_id}/charts
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the organization |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
The desired bucketing strategy for the charts. Defaults to |
|
|
N |
A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month. |
|
|
N |
A datetime for the end of the desired range for which to fetch costs. Defaults to the current date. |
Responses
edit-
200
-
The usage charts of an organization.
-
400
-
The specified date range is invalid. (code:
costs.invalid_date_range
)Headers
-
x-cloud-error-codes
(string
; allowed values: [costs.invalid_date_range
]) - The error codes associated with the response
-
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
Organization not found. (code:
organization.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
]) - The error codes associated with the response
-
-
429
-
Too many requests. (code:
billing_service.rate_limited
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.rate_limited
]) - The error codes associated with the response
-
-
500
-
Error fetching the itemized costs for the organization. (code:
billing_service.failed_request
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.failed_request
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}/charts \ -H "Authorization: ApiKey $EC_API_KEY"
Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
editEXPERIMENTAL (it may change in future versions): Retrieves the costs associated with all deployments for the organization.
Request
editGET /api/v1/billing/costs/{organization_id}/deployments
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the organization |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
A datetime for the beginning of the desired range for which to fetch activity. Defaults to start of current month. |
|
|
N |
A datetime for the end of the desired range for which to fetch activity. Defaults to the current date. |
Headers
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
Accept header containing the content preference. |
Responses
edit-
200
-
The costs associated to a set of products
-
400
-
Invalid date range specified. (code:
costs.invalid_date_range
)Headers
-
x-cloud-error-codes
(string
; allowed values: [costs.invalid_date_range
]) - The error codes associated with the response
-
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
Organization not found. (code:
organization.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
]) - The error codes associated with the response
-
-
500
-
An error occurred when fetching the costs associated with all deployments for the organization. (code:
billing_service.failed_request
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.failed_request
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}/deployments \ -H "Authorization: ApiKey $EC_API_KEY" \ -H Accept: string
Get charts by deployment. Currently unavailable in self-hosted ECE.
editEXPERIMENTAL (it may change in future versions): Retrieves the usage charts for the given deployment.
Request
editGET /api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/charts
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Id of a Deployment |
|
|
Y |
Identifier for the organization |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
The desired bucketing strategy for the charts. Defaults to |
|
|
N |
A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month. |
|
|
N |
A datetime for the end of the desired range for which to fetch costs. Defaults to the current date. |
Responses
edit-
200
-
The usage charts of a deployment.
-
400
-
The specified date range is invalid. (code:
costs.invalid_date_range
)Headers
-
x-cloud-error-codes
(string
; allowed values: [costs.invalid_date_range
]) - The error codes associated with the response
-
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
Organization not found. (code:
organization.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
]) - The error codes associated with the response
-
-
429
-
Too many requests. (code:
billing_service.rate_limited
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.rate_limited
]) - The error codes associated with the response
-
-
500
-
Error fetching the itemized costs for the organization. (code:
billing_service.failed_request
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.failed_request
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/charts \ -H "Authorization: ApiKey $EC_API_KEY"
Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
editEXPERIMENTAL (it may change in future versions): Retrieves the itemized costs for the given deployment.
Request
editGET /api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/items
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Id of a Deployment |
|
|
Y |
Identifier for the organization |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month. |
|
|
N |
A datetime for the end of the desired range for which to fetch costs. Defaults to the current date. |
Headers
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
Determines the response body format. Can be either application/json or text/csv. |
Responses
edit-
200
-
The costs associated to a set items billed for a single deployment.
-
400
-
The specified date range is invalid. (code:
costs.invalid_date_range
)Headers
-
x-cloud-error-codes
(string
; allowed values: [costs.invalid_date_range
]) - The error codes associated with the response
-
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
-
The organization was not found. (code:
organization.not_found
) -
The Elasticsearch cluster was not found. (code:
billing_service.es_cluster_id_not_found
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
,billing_service.es_cluster_id_not_found
]) - The error codes associated with the response
-
The organization was not found. (code:
-
500
-
An error occurred when fetching the itemized costs for the given deployment of the organization. (code:
billing_service.failed_request
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.failed_request
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/items \ -H "Authorization: ApiKey $EC_API_KEY" \ -H Accept: string
Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
editEXPERIMENTAL (it may change in future versions): Retrieves the itemized costs for the organization.
Request
editGET /api/v1/billing/costs/{organization_id}/items
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the organization |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month. |
|
|
N |
A datetime for the end of the desired range for which to fetch costs. Defaults to the current date. |
Responses
edit-
200
-
The costs associated to a set of items
-
400
-
The specified date range is invalid. (code:
costs.invalid_date_range
)Headers
-
x-cloud-error-codes
(string
; allowed values: [costs.invalid_date_range
]) - The error codes associated with the response
-
-
403
-
The current user does not have access to the requested organization. (code:
organization.invalid_access
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.invalid_access
]) - The error codes associated with the response
-
-
404
-
Organization not found. (code:
organization.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [organization.not_found
]) - The error codes associated with the response
-
-
500
-
Error fetching the itemized costs for the organization. (code:
billing_service.failed_request
)Headers
-
x-cloud-error-codes
(string
; allowed values: [billing_service.failed_request
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://api.elastic-cloud.com/api/v1/billing/costs/{organization_id}/items \ -H "Authorization: ApiKey $EC_API_KEY"