Get costs overview for the organization. Currently unavailable in self-hosted ECE.
editGet 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
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the organization |
Query parameters
edit| Name | 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://{{hostname}}/api/v1/billing/costs/{organization_id} \
-H "Authorization: ApiKey $ECE_API_KEY"