---
updatedAt: 2026-04-21T08:54:41.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# List billing usages.

This endpoint returns billing usage statistics.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "BillingUsage": {
        "description": "Represents billing usage data for runs by time periods.",
        "properties": {
          "attributes": {
            "properties": {
              "account-id": {
                "description": "The ID of the account.",
                "nullable": true,
                "type": "string"
              },
              "account-name": {
                "description": "The name of the account.",
                "nullable": true,
                "type": "string"
              },
              "environment-id": {
                "description": "The environment ID.",
                "nullable": true,
                "type": "string"
              },
              "environment-name": {
                "description": "The environment name.",
                "nullable": true,
                "type": "string"
              },
              "plan-apply-runs": {
                "default": 0,
                "description": "The number of plan & apply runs.",
                "type": "integer"
              },
              "plan-only-runs": {
                "default": 0,
                "description": "The number of plan-only runs.",
                "type": "integer"
              },
              "total-runs": {
                "default": 0,
                "description": "The total number of runs.",
                "type": "integer"
              },
              "workspace-id": {
                "description": "The workspace ID.",
                "nullable": true,
                "type": "string"
              },
              "workspace-name": {
                "description": "The workspace name.",
                "nullable": true,
                "type": "string"
              }
            },
            "type": "object"
          },
          "id": {
            "readOnly": true,
            "type": "string"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "type": {
            "enum": [
              "billing-usages"
            ],
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "BillingUsageListingDocument": {
        "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/BillingUsage"
            },
            "type": "array"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "readOnly": true,
            "type": "object"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/reports/billing": {
      "get": {
        "description": "This endpoint returns billing usage statistics.",
        "operationId": "list_billing_usage",
        "parameters": [
          {
            "description": "The date filter. Example: `filter[date]=between:2022-01-01T00:00:00Z,2022-02-01T00:00:00Z`",
            "in": "query",
            "name": "filter[date]",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Format of the response. It can be 'json' or 'csv'.",
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Breakdown by account, environment, workspace or both (comma-separated) If the parent control tower account breaks down by workspace and environment shows the values from current account.",
            "in": "query",
            "name": "breakdown-by",
            "required": false,
            "schema": {
              "items": {
                "enum": [
                  "account",
                  "environment",
                  "workspace"
                ],
                "type": "string"
              },
              "type": "array"
            }
          },
          {
            "description": "Search by workspace/environment name or ID.",
            "in": "query",
            "name": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Restrict the report to specific accounts within the Control Tower parent's billing group. Honored only for a parent account; each ID must belong to the parent's billing group. Example: `filter[account]=in:acc-xxx,acc-yyy`.",
            "in": "query",
            "name": "filter[account]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page number.",
            "in": "query",
            "name": "page[number]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page size.",
            "in": "query",
            "name": "page[size]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The comma-separated list of attributes.",
            "explode": false,
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "items": {
                "enum": [
                  "account-name",
                  "environment-name",
                  "plan-apply-runs",
                  "plan-only-runs",
                  "total-runs",
                  "workspace-name"
                ],
                "type": "string"
              },
              "type": "array"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/BillingUsageListingDocument"
                }
              },
              "text/csv": {
                "schema": {
                  "format": "csv",
                  "type": "string"
                }
              }
            },
            "description": "Success."
          },
          "403": {
            "description": "User unauthorized to perform this action."
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "List billing usages.",
        "tags": [
          "billing-usage"
        ],
        "x-mcp-tool": true,
        "x-resource": "BillingUsage",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```