Skip to main content
GET
Retrieve customer usage

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Path Parameters

customer
string
required

Customer public id, e.g. cus_....

Query Parameters

period
string

Billing period, YYYY-MM. Defaults to the current month.

Response

Usage.

Usage for one customer and one billing period, in this key's mode. LazyApp adds 0% to Meta's rates, so charges are non-zero only for sends LazyApp pays Meta for.

totals
object
previousTotals
object | null

The same totals for the month before, plus its period.

comparison
object | null
costStack
object[]

What totals.totalCharge is made of.

daily
object[]
byCategory
object[]
byRegion
object[]
byPhoneNumber
object[]
byTemplate
object[]

Top 15 templates by charge.

freeVsPaid
object
spending_limit_cents
integer | null
wallet_balance_cents
integer

Prepaid balance in minor units, used when billing_mode is prepaid. It is debited only for sends LazyApp pays Meta for, at Meta's rate. Sends on numbers where Meta bills the business directly cost nothing here.

billing_mode
enum<string>
Available options:
inherit,
prepaid,
postpaid