Retrieve the account of a dashboard session
GET /v1/dashboard/account
The account, its plan, this month’s usage in the shape of GET /v1/project, what is accepted and not yet counted, and every project with every key. Never a secret: a key is shown by its prefix.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”Success.
object
object
Identifier of a account, prefixed with acct_.
Example
acct_0198f0c2a1b47e2e9a1c0f4d5e6a7b8cThis month’s usage of the plan, summed over the account’s projects: the same object GET /v1/project returns.
object
The calendar month the numbers are about, in UTC: YYYY-MM.
Example
2026-09Live bookings of every project of the account that reached confirmed this month, each counted once. Cancellations, holds, no-shows and reschedules do not count again; the test environment never counts.
Confirmed live bookings the plan includes each month. null: negotiated.
Live payments that succeeded this month, net of the refunds made this month, in the minor unit. Can be negative after a refund of an earlier month.
Paid volume the plan includes each month, in the minor unit. null: not capped (a paying plan is billed on the volume instead).
The currency of payment_volume: the one currency this month’s payments were in, mixed when there were several (no conversion is made), null when no money moved.
Whether reaching an included quantity refuses the next live booking with 402 plan_limit_reached. True on the free plan only.
What the account has accepted and not yet counted.
object
Live bookings in pending right now, every month. On the free plan they count against the threshold already, together with usage.bookings_confirmed.
Open live payments of pending bookings, in the minor unit. On the free plan they count against the included volume, together with usage.payment_volume.
object
Identifier of a project, prefixed with proj_.
Example
proj_0198f0c2a1b47e2e9a1c0f4d5e6a7b8cISO 8601 instant in UTC.
Example
2026-09-08T07:00:00Zobject
Identifier of a api_key, prefixed with key_.
Example
key_0198f0c2a1b47e2e9a1c0f4d5e6a7b8cThe environment of the API key that created the object.
The first eight characters after sk_test_ or sk_live_: enough to recognise a key, never enough to use it.
Optional tenant this object belongs to, for multi-tenant customers.
ISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZThe last request made with the key, to the minute. null: never used.
Example
2026-09-08T07:00:00ZISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZThe session this answer was read with.
object
ISO 8601 instant in UTC.
Example
2026-09-08T07:00:00ZThe Stripe subscription of the account, or null when it has never had one. The plan of the account follows it.
object
Whether the account still has this subscription: incomplete, trialing, active or past_due. While it is live a second checkout is refused; unpaid and paused are not live.
The end of the current period: the first of the next month, at midnight UTC.
Example
2026-09-08T07:00:00ZThe plan the subscription moves to at the end of the period, when a move down is scheduled.
The first failed payment of the period, or null when payments are up to date.
Example
2026-09-08T07:00:00ZFourteen days after past_due_since: if no payment has succeeded by then, the subscription is closed and the account returns to Free.
Example
2026-09-08T07:00:00ZAn invoice left open when the subscription was closed for non payment, or null. A new checkout is refused until it is paid.
object
The Stripe page where the invoice is paid (hosted_invoice_url).
The versions of the terms in force, and whether the account has accepted them.
object
When the account accepted these versions of the terms and of the DPA, or null: then the checkout asks for both ticks first.
Example
2026-09-08T07:00:00ZHeaders
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Requests this key may have in flight at one instant: the burst of its policy.
Requests this key may still make right now, as a whole number.
Whole seconds until RateLimit-Remaining is back at RateLimit-Limit.
unavailable when no limit could be applied to this request, because the store that holds the counters did not answer. The three counters are then absent and the request was served.
Error codes: parameter_invalid, unsupported_api_version.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Requests this key may have in flight at one instant: the burst of its policy.
Requests this key may still make right now, as a whole number.
Whole seconds until RateLimit-Remaining is back at RateLimit-Limit.
unavailable when no limit could be applied to this request, because the store that holds the counters did not answer. The three counters are then absent and the request was served.
Error codes: dashboard_session_invalid.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Requests this key may have in flight at one instant: the burst of its policy.
Requests this key may still make right now, as a whole number.
Whole seconds until RateLimit-Remaining is back at RateLimit-Limit.
unavailable when no limit could be applied to this request, because the store that holds the counters did not answer. The three counters are then absent and the request was served.
Error codes: rate_limited.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Requests this key may have in flight at one instant: the burst of its policy.
Requests this key may still make right now, as a whole number.
Whole seconds until RateLimit-Remaining is back at RateLimit-Limit.
unavailable when no limit could be applied to this request, because the store that holds the counters did not answer. The three counters are then absent and the request was served.
Whole seconds to wait before sending this request again. At least 1.
Error codes: internal_error.
object
object
Machine readable code. The set is per operation; each response below lists the ones it can produce.
The field or header the error is about, when there is one.
What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.
Headers
Section titled “Headers ”Identifier of this request. Quote it to support.
The API version this response was produced with.
Requests this key may have in flight at one instant: the burst of its policy.
Requests this key may still make right now, as a whole number.
Whole seconds until RateLimit-Remaining is back at RateLimit-Limit.
unavailable when no limit could be applied to this request, because the store that holds the counters did not answer. The three counters are then absent and the request was served.