Skip to content

The visits billing reported to Stripe's meter, per UTC day, from from to to: its owner

GET
/v1/buyer/billing/usage-reports
curl --request GET \
--url 'https://example.com/v1/buyer/billing/usage-reports?sort=day' \
--header 'Authorization: Bearer <token>'

Who: a workspace’s owner. Not for API keys.

page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

from
string
to
string

OK

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string | null format: date-time
day
required
string format: date-time
identifier
required
string
sent_at
required
string | null format: date-time
status
required
string | null
Allowed values: pending sent unconfirmed
visits
required
integer format: int64
visits_total
required
integer format: int64
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example

{
"data": [
{
"status": "pending"
}
]
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}