Skip to main content
GET
Get Sailbox spend

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from
string<date-time>

Start of the window, as an RFC 3339 timestamp. Defaults to the first of the current UTC month.

to
string<date-time>

End of the window, as an RFC 3339 timestamp. Defaults to now, and must be after from.

app_id
string

Only count Sailboxes in this app.

sailbox_id
string

Only count this Sailbox.

Pattern: ^(sb_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})?$

Response

The spend summary.

start_at
string<date-time>
required

Start of the window.

end_at
string<date-time>
required

End of the window.

finalized_cost_usd_nanos
integer<int64>
required

Cost of time already used, in billionths of a US dollar.

estimated_active_cost_usd_nanos
integer<int64>
required

Estimated cost of time still in progress.

estimated_total_cost_usd_nanos
integer<int64>
required

Finalized plus estimated active cost.

duration_seconds
integer<int64>
required

Total Sailbox seconds in the window.

vcpu_seconds
number
required

Total virtual CPU seconds used.

memory_gib_seconds
number
required

Total memory GiB seconds used.

state_disk_gib_seconds
number
required

Total disk GiB seconds used.

rates
object
required

Prices used to work out the costs in this response, in billionths of a US dollar. New rates can appear over time.

sailboxes
object[]
required

Per-Sailbox breakdown.