Skip to main content
GET
Get business messaging usage summary

Query Parameters

periodStart
string<date-time>

The period start.

periodEnd
string<date-time>

The period end.

Response

Returns the usage summary response.

API DTO containing usage summary response data.

periodStart
string<date-time>

The date and time for the period start value on this usage summary.

periodEnd
string<date-time>

The date and time for the period end value on this usage summary.

customerChargeTotal
string<double>

The customer charge total for this usage summary.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
billableQuantityTotal
string<double>

The billable quantity total for this usage summary.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
usageRecordCount
string<int32>

The usage record count for this usage summary.

Pattern: ^-?(?:0|[1-9]\d*)$
pendingInvoiceCount
string<int32>

The pending invoice count for this usage summary.

Pattern: ^-?(?:0|[1-9]\d*)$
failedCount
string<int32>

The failed count for this usage summary.

Pattern: ^-?(?:0|[1-9]\d*)$
lines
object[]

The lines included with this usage summary.

counters
object[]

The named usage counters included with this usage summary.