Skip to main content
GET
Get organization messaging usage summary

Authorizations

Authorization
string
header
required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Query Parameters

periodStart
string<date-time>

The period start.

periodEnd
string<date-time>

The period end.

Response

Returns the usage summary response.

Describes usage summary response data used by Leadping.

periodStart
string<date-time>

UTC timestamp for period start on this usage summary.

periodEnd
string<date-time>

UTC timestamp for period end on this usage summary.

customerChargeTotal
number<double>

The customer charge total for this usage summary.

billableQuantityTotal
number<double>

The billable quantity total for this usage summary.

transactionCount
integer<int32>

The usage record count for this usage summary.

pendingInvoiceCount
integer<int32>

The pending invoice count for this usage summary.

failedCount
integer<int32>

The failed count for this usage summary.

lines
object[]

The lines included with this usage summary.

counters
object[]

The named usage counters included with this usage summary.