List account and commitment settings per AWS organization

get

https://api.doit.com/ps4commitments/v1/aws/settings

Returns one item per onboarded AWS organization. Each item includes that AWS organization's commitments purchasing account (purchaseAccountId) and commitment settings for each commitment type activated on that AWS organization (compute, database).

Commitment settings cover recommendation and automation preferences (policy, term, payment option, automation mode, commitment limits, and related fields). They are stored at the customer level per commitment type and therefore have the same values on every AWS organization item. Only purchaseAccountId and which commitment types appear differ per AWS organization.

In the DoiT Console, commitment settings are edited on an account's Settings tab but apply across all AWS organizations for that commitment type; the purchasing account is set per AWS organization on Accounts Settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageToken

string

Opaque cursor token returned by a previous list response. Omit to start from the beginning; an empty or absent token in a response means there are no more results. Do not parse it. A structurally invalid cursor returns 400 with code pagination_token_invalid; an expired cursor returns 400 with code pagination_token_expired — restart pagination from the beginning.

maxResults

integer

1 to 500

Defaults to 50

Maximum number of items to return. Server may return fewer. Defaults to 50; maximum 500.

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. Omitting it returns 400 with code tenant_id_required. If the value conflicts with the tenants your credential may access, the request returns 400 with code tenant_id_mismatch. 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

200Settings payload for one onboarded AWS organization, with that AWS organization's purchasing account (purchaseAccountId) and customer-level commitment settings for each activated commitment type (services[].settings).

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

401Missing or invalid credentials.

403Authenticated but not authorized to perform this request.

500Unexpected server error.

503Service temporarily unavailable; retry after the indicated delay.