Skip to main content
GET
Read mailbox costs

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-None-Match
string

Return 304 when the authorised response is unchanged.

Path Parameters

public_id
string
required

Mailbox public ID.

Query Parameters

start
string<date-time>
required

Inclusive start. At most millisecond precision.

end
string<date-time>
required

Exclusive end. Must be at or after start and at most 366 days later. At most millisecond precision.

Response

Recorded mailbox costs and settlement state.

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required