Rivier/ Reference/ inbox

Inbox message usage

get/messages/usage

Messages and billable units this period by channel and direction, for plan metering. Defaults to the current calendar month.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:read
Graphql
Query.inboxMessageUsage
Sdk
inbox.message.usage
Cli
inbox message usage

Parameters

  • sincestring
    In the query
  • untilstring
    In the query

Responses

  • 200application/json
    Success
    • sincestringrequired
    • untilstringrequired
    • usagelist of objectrequired
      • channelstringrequired
        One of: email, sms, mms, whatsapp, voice, verify, lookup.
      • directionstringrequired
        One of: out, in.
      • messagesnumberrequired
      • unitsnumberrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown