Skip to main content
GET
Get usage

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

Response

The project account’s usage for the current billing period, not limited to this project. Requires a signed-in account Owner or Admin with project.settings.manage and account.billing.read; project-only collaborators, API keys and service accounts are rejected.

storage
object
required
bandwidth
object
required
api_calls
object
required
custom_domains
object
required
code_exports
object
required
veryfront_badge
object
required
period_start
string
required

ISO timestamp for the start of the current billing period.

period_end
string
required

ISO timestamp for the end of the current billing period.

scope
enum<string>
required

The scope of the reported usage. Always "account": values cover the project’s owning account for the current billing period, rather than this project alone.

Available options:
account