## List Balances

`v1.contracts.list_balances(**kwargs) -> ContractListBalancesResponse`

**post** `/v1/contracts/customerBalances/list`

List balances (commits and credits).

### Parameters

- **customer\_id:** `String`

- **id:** `String`

- **covering\_date:** `Time`

  Return only balances that have access schedules that "cover" the provided date

- **effective\_before:** `Time`

  Include only balances that have any access before the provided date (exclusive)

- **include\_archived:** `bool`

  Include archived credits and credits from archived contracts.

- **include\_balance:** `bool`

  Include the balance of credits and commits in the response. Setting this flag may cause the query to be slower.

- **include\_contract\_balances:** `bool`

  Include balances on the contract level.

- **include\_ledgers:** `bool`

  Include ledgers in the response. Setting this flag may cause the query to be slower.

- **limit:** `Integer`

  The maximum number of commits to return. Defaults to 25.

- **next\_page:** `String`

  The next page token from a previous response.

- **starting\_at:** `Time`

  Include only balances that have any access on or after the provided date

### Returns

- `class ContractListBalancesResponse`

  - **data:** `Array[Commit | Credit]`

    - `Commit`

    - `Credit`

  - **next\_page:** `String`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.contracts.list_balances(customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d")

puts(response)
```