Billing & Usage APIs

Creating and managing accounts, projects, and clients for development.

Retrieve current billing and usage for a project

get

This endpoint provides the current billing and usage information for the specified project. It is intended for users to monitor their project's financial metrics and resource consumption. Access is secured and requires appropriate authentication.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: projects.billing.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/console/projects/{projectId}/billing

Retrieve API usage statistics for a project

get

This endpoint provides detailed API usage metrics for a specified project. Users can obtain statistics such as the number of API calls and user activity over a defined time interval. It is designed to assist developers in monitoring and optimizing their project's API consumption.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Query parameters
startstringOptionalDefault: 10m
intervalstringOptionalDefault: 10s
Responses
200

OK

*/*
get
/console/projects/{projectId}/usage/apis

Retrieve compute usage metrics for a project

get

This endpoint provides the details about any compute resources being consumed by the project. This will return an array of the compute nodes found, their instance type and limits.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/console/projects/{projectId}/usage/compute

Retrieve compute usage metrics for a project

get

This endpoint provides the details about any compute resources being consumed by the project. This will return an array of the compute nodes found, their instance type and limits.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Query parameters
startstringOptionalDefault: NOW/DAY-1DAY
stopstringOptionalDefault: NOW
Responses
200

OK

*/*
get
/console/projects/{projectId}/usage/compute/history

Retrieve HTTP usage metrics for a project

get

This endpoint provides detailed statistics on the HTTP usage of a specified project. It includes metrics such as the number of users and their activity over a defined time interval. This information is essential for monitoring project performance and user engagement.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Query parameters
startstringOptionalDefault: 10m
intervalstringOptionalDefault: 10s
Responses
200

OK

*/*
get
/console/projects/{projectId}/usage/http

Retrieve project user statistics and metrics

get

This endpoint returns key statistics for the specified project, including user counts and detailed user lists. It is designed for service developers and console users to gain insights into project usage. Access is secured and requires appropriate authentication.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/console/projects/{projectId}/usage/stats

Retrieve user statistics for the current project

get

This endpoint provides detailed statistics about the users associated with the specified project. It includes metrics such as the total number of users and their respective lists. This information is crucial for understanding user engagement and project usage.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/console/projects/{projectId}/usage/users

Last updated