Skip to main content
GET
Monthly workspace usage and reported SMS costs

Authorizations

__Secure-better-auth.session_token
string
cookie
required

Better Auth session with selected organization. Mutations also require the trusted Origin header.

Query Parameters

month
string
Pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$

Response

Successful JSON response

month
string
required
Pattern: ^20\d{2}-(0[1-9]|1[0-2])$
timezone
string
required
Allowed value: "UTC"
start
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
endExclusive
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
email
object[]
required
sms
object[]
required
basis
string
required
Allowed value: "message_created_at"
costSource
string
required
Allowed value: "papers_ledger"
billingStatus
string
required
Allowed value: "prepaid"