Authorize API Requests

Stay organized with collections Save and categorize content based on your preferences.

When your application requests private data, the request must be authorized by an authenticated user who has access to that data.

When your application requests public data, the request doesn't need to be authorized, but does need to be accompanied by an identifier, such as an API key.

Every request your application sends to the Cloud Billing API must include an authorization token. The token also identifies your application to Google.

About authorization protocols

Your application must use OAuth 2.0 to authorize requests. No other authorization protocols are supported. If your application uses Sign In With Google, some aspects of authorization are handled for you.

Authorizing requests with OAuth 2.0

All requests to the Cloud Billing API must be authorized by an authenticated user.

The details of the authorization process, or "flow," for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:

  1. When you create your application, you register it using the Google Cloud console. Google then provides information you'll need later, such as a client ID and a client secret.
  2. Activate the Cloud Billing API in the Google Cloud console. (If the API isn't listed in the Google Cloud console, then skip this step.)
  3. When your application needs access to user data, it asks Google for a particular scope of access.
  4. Google displays a consent screen to the user, asking them to authorize your application to request some of their data.
  5. If the user approves, then Google gives your application a short-lived access token.
  6. Your application requests user data, attaching the access token to the request.
  7. If Google determines that your request and the token are valid, it returns the requested data.

Some flows include additional steps, such as using refresh tokens to acquire new access tokens. For detailed information about flows for various types of applications, see Google's OAuth 2.0 documentation.

Here's the OAuth 2.0 scope information for the Cloud Billing API:

Scope Meaning Access to view and manage data across Google Cloud Platform services. This is the broadest scope, sufficient to call any Cloud Billing API method. This scope implies cloud-billing and cloud-billing.readonly, so if you have this scope, you don't need either of the others. Access to view and manage Google Cloud Platform billing accounts. This scope is narrower than cloud-platform, but it's broader than (and it implies) cloud-billing.readonly. Access to view Google Cloud Platform billing accounts. This is the narrowest scope. You can use this scope if you only need to get and list billing accounts, and don't need to retrieve or update ProjectBillingInfo resources.

To request access using OAuth 2.0, your application needs the scope information, as well as information that Google supplies when you register your application (such as the client ID and the client secret).