Mailboxes

Read mailbox costs

Changed on

Read cumulative mailbox costs for a half-open window: start is included and end is excluded. Requires mailbox.admin.read and team-wide mailbox access. Retained usage remains readable after mailbox deletion while the team and credential remain active. Quantities and USD amounts are decimal strings. posted_amount includes only posted charges; incurred and unbillable amounts are reported separately. A pending result can change. Settle a window only when its state is final. This read does not start or complete settlement.

get/mailboxes/{public_id}/usage

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailboxes/{public_id}/usage
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.admin.read)

Path parameters

public_idstring required

Mailbox public ID.

Query parameters

startstring date-time required

Inclusive start. At most millisecond precision.

endstring date-time required

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

Headers

If-None-Matchstring

Return 304 when the authorised response is unchanged.

Response

Recorded mailbox costs and settlement state.

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes