Skip to main content

list-shared-payer-management-accounts 

dci list-shared-payer-management-accounts <customerId>

Lists the reseller's linked shared-payer management (payer) accounts that have completed onboarding, for use in an account picker. Requires the SharedPayersAdmin permission and DoiT API access (platform:externalApi). User API tokens must include the permission in their scope.

  • customerId — Customer ID. Must match the customer resolved from the bearer token - a token scoped to a different customer gets 403.

Output​

OK - Shared-payer management accounts returned.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
itemsarray of object
items[].payerIdstringAWS account ID of the management (payer) account.
items[].payerNamestringDisplay name of the management (payer) account.
Raw JSON schema
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A linked shared-payer management (payer) account that has completed onboarding.",
        "properties": {
          "payerId": {
            "type": "string",
            "description": "AWS account ID of the management (payer) account."
          },
          "payerName": {
            "type": "string",
            "description": "Display name of the management (payer) account."
          }
        }
      }
    }
  }
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listsharedpayermanagementaccounts