---
title: "List Balances"
method: GET
path: "/organizations/{orgId}/balances"
tags: ["Balances"]
---

# List Balances

`GET /organizations/{orgId}/balances`

Retrieve a list of all Balances for your Organization.

This endpoint returns a list of all Balances associated with your organization. You can filter the Balances by the end customer's Account UUID and end dates, and paginate through them using the `pageSize` and `nextToken` parameters.

**NOTE:** If a Balance has a rollover amount configured and you want to use the `endDateStart` or `endDateEnd` query parameters, the `rolloverEndDate` is used as the end date for the Balance.

## Path parameters

- `orgId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `accountId` string
- `endDateStart` string
- `endDateEnd` string
- `contract` string
- `contractId` string
- `ids` string[]

## Response `200`

Returns list of Balances

- PaginatedBalanceResponseData
  - `data` BalanceResponse[]
    - `id` string, required — The UUID of the entity.
    - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
    - `customFields` object — User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number. If `customFields` can also be defined for this entity at the Organizational level,`customField` values defined at individual level override values of `customFields` with the same name defined at Organization level. See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.
    - `code` string — A unique short code assigned to the Balance.
    - `name` string — The official name of the Balance.
    - `description` string — A description of the Balance.
    - `accountId` string — The unique identifier (UUID) for the end customer Account the Balance belongs to.
    - `amount` number — The financial value that the Balance holds.
    - `currency` string — The currency code used for the Balance amount. For example: USD, GBP or EUR.
    - `startDate` string, date-time — The date *(in ISO 8601 format)* when the Balance becomes active.
    - `endDate` string, date-time — The date *(in ISO 8601 format)* after which the Balance will no longer be active.
    - `rolloverAmount` number — The maximum amount that can be carried over past the Balance end date and draw-down against for billing if there is an unused Balance amount remaining when the Balance end date is reached.
    - `rolloverEndDate` string, date-time — The end date *(in ISO 8601 format)* for the rollover grace period, which is the period that unused Balance amounts can be carried over beyond the specified Balance `endDate` and continue to be drawn-down against for billing.
    - `balanceDrawDownDescription` string — A description for the bill line items for charges drawn-down against the Balance.
    - `overageSurchargePercent` number, double — The percentage surcharge applied to overage charges *(usage above the Balance)*.
    - `overageDescription` string — A description for overage charges.
    - `productIds` string[] — A list of Product IDs whose consumption charges due at billing can be drawn-down against the Balance amount.
    - `lineItemTypes` BalanceLineItemType[] — A list of line item charge types that can draw-down against the Balance amount at billing.
    - `contractId` string — The unique identifier (UUID) for a Contract on the Account the Balance has been added to.
    - `consumptionsAccountingProductId` string — Product ID that any Balance Consumed line items will be attributed to for accounting purposes.(*Optional*)
    - `feesAccountingProductId` string — Product ID that any Balance Fees line items will be attributed to for accounting purposes.(*Optional*)
    - `dtCreated` string, date-time — The date and time *(in ISO 8601 format)* when the Balance was first created.
    - `dtLastModified` string, date-time — The date and time *(in ISO 8601 format)* when the Balance was last modified.
    - `createdBy` string — The unique identifier (UUID) for the user who created the Balance.
    - `lastModifiedBy` string — The unique identifier (UUID) for the user who last modified the Balance.
  - `nextToken` string

## Other responses

- `4XX` — Error message
- `5XX` — Error message

---

[API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)