List GCP recommendations

Returns commitment purchase recommendations for the billing account, filtered to the
term preferred in each product line's settings (preferredCommitmentPeriod).

gcp_service and region filters: omit both to return recommendations for all
product lines (compute, cloud_sql) across all their regions. Supply gcp_service
alone to return all regions for that service; supply both to return a single
service/region scope. region requires gcp_service — a request with region but no
gcp_service returns 400 with code gcp_service_required. A region that is malformed
or incompatible with gcp_service (compute is global-only, cloud_sql is
regional-only) returns 400 with code validation_failed; a well-formed, compatible
region with no data returns 200 with an empty items array.

404 is returned only when the billing account does not exist or the caller cannot access
it. A billing account with no matching recommendation documents returns 200 with an empty
items array.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Z0-9]{6}-[A-Z0-9]{6}-[A-Z0-9]{6}$

GCP Billing Account ID (format XXXXXX-XXXXXX-XXXXXX; the account that owns the CUDs) that scopes the request.

Query Params
string
enum

Filter by PerfectScale for Commitments GCP product line. Omit to return all product lines. Matching is case-insensitive; the value is lowercased before validation.

Show Details
computeCompute commitment type (CUDs). Global scope only (`region=global`).
cloud_sqlCloud SQL commitment type (CUDs). Regional scope only (`region` is a concrete region, never `global`).
Allowed:
string
^(global|[a-z]+(_[a-z0-9]+)+)$

Filter by region scope, in lower_snake_case wire form (for example us_east1), or the
literal global. Requires gcp_service; a request with region but no gcp_service
returns 400 with code gcp_service_required. When both are omitted, all available
regions for all available product lines are returned.

The value is format-validated, not checked against a closed region list: compute accepts
only global, cloud_sql accepts only concrete regions (never global), and a value that
is malformed or incompatible with gcp_service returns 400 with code validation_failed.
A well-formed, service-compatible region with no data returns 200 with an empty result.
Matching is case-insensitive; the value is lowercased before validation.

Headers
string

Customer (tenant) ID for the request. This is separate from authentication: you still pass your personal or service account API token in the Authorization header (Bearer <token>). See Get Started.

When to omit (most callers): If your personal or service account token belongs to a single customer, omit this header. The API resolves that customer from the token.

When to send: If your credential can access more than one customer, set X-Tenant-Id to the customer ID you want to act on. A service account can select an active direct or nested descendant of its home customer; the endpoint's normal permissions, entitlements, and resource-ownership checks still apply. A service-account target outside that customer subtree returns 403 Forbidden. Prefer this header over the legacy customerContext query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json