Get a GCP billing account

get

https://api.doit.com/ps4commitments/v1/gcp/billing-accounts/{billingAccountId}

Returns a single GCP Billing Account with the same list-item fields as List GCP Billing Accounts, plus the Overview time series. Use this when you need a single billing account's Console Overview in one call (identity and onboarding status, 30-day ESR and savings, YTD/lifetime totals, CUD export health, and the data behind Cost Summary and CUD Coverage charts) without fetching every billing account.

Fields that drive the Overview tab in the DoiT console — each is an array with one entry per product line (service of compute or cloud_sql):

stats30d: last 30 days ESR and realized savings per product line (ESR and Savings cards).
monthlyStats: last 6 calendar months of ESR, on-demand cost, and cost with savings per product line (Cost Summary chart, and month-over-month card trends).
dailyCoverage: last 30 days of CUD coverage breakdown per product line (CUD Coverage chart).
savingsTotals: year-to-date and lifetime realized savings per product line (shown under the Savings card). Lifetime is bounded by PerfectScale for Commitments onboarding start.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

billingAccountId

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.

Headers

X-Tenant-Id

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Single GCP Billing Account details (same list-item fields as provided for the billing account through list GCP billing accounts operation) and overview time series: 6 months stats and 30 days of CUD coverage.

400Syntactically malformed request, missing required parameter, or unsupported parameter value.

401Missing or invalid credentials.

403Authenticated but not authorized to perform this request.

404The requested resource does not exist.

500Unexpected server error.

503Service temporarily unavailable; retry after the indicated delay.