Get costs overview for the organization

edit

EXPERIMENTAL (it may change in future versions): Retrieves an overview of the costs by organization ID.

Request

edit

GET /api/v1/billing/costs/{organization_id}

Path parameters

edit
Name Type Required Description

organization_id

string

Y

Identifier for the organization

Query parameters

edit
Name Type Required Description

from

string

N

A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month. Note: there is currently a three-month maximum date range.

to

string

N

A datetime for the end of the desired range for which to fetch costs. Defaults to the current date. Note: there is currently a three-month maximum date range.

Responses

edit
200

(CostsOverview) Top-level cost overview for the organization

403

(BasicFailedReply) 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

Request example

edit
curl -XGET https://{{hostname}}/api/v1/billing/costs/{organization_id} \
-H "Authorization: ApiKey $ECE_API_KEY"