list-payer-accounts-settings

dci list-payer-accounts-settings [flags]

Returns automation and recommendation engine settings for every onboarded payer account, broken down by product line (compute, database). Settings are configured at the customer level and apply uniformly across all payer accounts. Only product lines that are activated/onboarded for a given payer account are returned. The purchaseAccountId is the linked AWS account designated to execute SP purchases on behalf of that payer account.

Flags

--page-token: (string)

--max-results: (integer default:50)

Responses

200 (application/json)

List of per-payer-account per-product-line engine settings.

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "payerAccountId",
          "purchaseAccountId",
          "services"
        ],
        "properties": {
          "payerAccountId": {
            "type": "string",
            "description": "12-digit AWS Master Payer Account ID.",
            "example": "123456789012"
          },
          "purchaseAccountId": {
            "type": "string",
            "description": "Linked AWS account used to execute SP purchases for this payer account. Null if not configured.",
            "nullable": true,
            "example": "987654321098"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "service",
                "settings"
              ],
              "properties": {
                "service": {
                  "type": "string",
                  "enum": [
                    "compute",
                    "database"
                  ],
                  "description": "Product line these settings apply to."
                },
                "settings": {
                  "type": "object",
                  "description": "Automation and recommendation engine settings for one product line.",
                  "required": [
                    "purchaseMode",
                    "minimumCommitment",
                    "lastDayOfMonthForPurchase",
                    "maximumCommitment",
                    "term",
                    "paymentOption",
                    "policy"
                  ],
                  "properties": {
                    "purchaseMode": {
                      "type": "string",
                      "enum": [
                        "autonomous",
                        "requires_approval"
                      ],
                      "description": "Whether purchases execute automatically or require approval."
                    },
                    "minimumCommitment": {
                      "type": "number",
                      "format": "double",
                      "description": "Minimum hourly commitment amount (USD) per purchase step."
                    },
                    "lastDayOfMonthForPurchase": {
                      "type": "integer",
                      "description": "Latest calendar day of the month on which a purchase may be scheduled."
                    },
                    "maximumCommitment": {
                      "type": "number",
                      "format": "double",
                      "description": "Maximum total hourly commitment (USD). 0 means no cap."
                    },
                    "term": {
                      "allOf": [
                        {
                          "type": "string",
                          "enum": [
                            "one_year",
                            "three_year"
                          ],
                          "description": "Commitment term length."
                        }
                      ],
                      "description": "Preferred commitment term length."
                    },
                    "paymentOption": {
                      "allOf": [
                        {
                          "type": "string",
                          "enum": [
                            "no_upfront",
                            "partial_upfront",
                            "all_upfront"
                          ],
                          "description": "Payment structure for a commitment.\n- `no_upfront` — all charges paid monthly\n- `partial_upfront` — a portion paid upfront; remainder monthly\n- `all_upfront` — full commitment paid upfront\n"
                        }
                      ],
                      "description": "Preferred payment structure for new commitments."
                    },
                    "policy": {
                      "allOf": [
                        {
                          "type": "string",
                          "enum": [
                            "conservative",
                            "balanced",
                            "max_savings"
                          ],
                          "description": "Coverage target policy.\n- `conservative` — lower coverage target (~65%)\n- `balanced` — moderate coverage target (~80%)\n- `max_savings` — aggressive coverage target (~90%)\n"
                        }
                      ],
                      "description": "Coverage target policy."
                    },
                    "upfrontPercentage": {
                      "type": "number",
                      "format": "double",
                      "description": "Fraction of the hourly commitment paid upfront (0–1). Only present when paymentOption is `partial_upfront`."
                    }
                  }
                }
              }
            },
            "description": "Settings for each activated product line."
          }
        }
      }
    },
    "pageToken": {
      "type": "string",
      "description": "Opaque cursor for the next page. Absent when this is the last page.",
      "nullable": true
    },
    "rowCount": {
      "type": "integer",
      "format": "int64",
      "description": "Number of items returned in this page."
    }
  }
}

400 (application/problem+json)

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

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

401 (application/problem+json)

Missing or invalid credentials.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

403 (application/problem+json)

Authenticated but not authorised to access this customer's PS4C resources.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

500 (application/problem+json)

Unexpected server error.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

503 (application/problem+json)

Service temporarily unavailable; retry after the indicated delay.

{
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "detail",
    "instance",
    "code",
    "retryable"
  ],
  "additionalProperties": true,
  "description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "example": "https://developer.doit.com/errors/not_found"
    },
    "title": {
      "type": "string",
      "example": "Resource not found"
    },
    "status": {
      "type": "integer",
      "example": 404
    },
    "detail": {
      "type": "string",
      "example": "customer not found"
    },
    "instance": {
      "type": "string",
      "format": "uri",
      "example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
    },
    "code": {
      "type": "string",
      "pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
      "example": "not_found"
    },
    "retryable": {
      "type": "boolean",
      "example": false
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "issue"
        ],
        "properties": {
          "issue": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*$"
          },
          "field": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "docsUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

Aliases: list-payer-accounts-settings, listpayeraccountssettings