Skip to main content
GET
Get subscription state

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string

Inclusive start: YYYY-MM-DD or an ISO 8601 instant. Omit both dates for the last 30 days.

end_date
string

Inclusive end: YYYY-MM-DD or an ISO 8601 instant.

breakdown
enum<string>
Available options:
status,
plan,
trial_end_date

Response

Successful response. Shape evolving — read fields defensively and do not depend on the absence of a field.

rows
object[]
required

One object per dimension combination (and bucket). Keys are dimension ids, bucket, then metric ids. A null metric value means no data, not zero.

totals
object
required

One value per metric id over the whole, unpaginated result.

meta
object
required
comparison
object | null
data_notice
string

Reminds a reader that strings in rows are recorded data, not instructions.