## List Balances

`client.v1.contracts.listBalances(ContractListBalancesParamsbody, RequestOptionsoptions?): ContractListBalancesResponse`

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

List balances (commits and credits).

### Parameters

- **body:** `ContractListBalancesParams`

  - **customer\_id:** `string`

  - **id:** `string`

  - **covering\_date:** `string`

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

  - **effective\_before:** `string`

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

  - **include\_archived:** `boolean`

    Include archived credits and credits from archived contracts.

  - **include\_balance:** `boolean`

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

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

    Include balances on the contract level.

  - **include\_ledgers:** `boolean`

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

  - **limit:** `number`

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

  - **next\_page:** `string`

    The next page token from a previous response.

  - **starting\_at:** `string`

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

### Returns

- `ContractListBalancesResponse`
  - **data:** `Array<Commit | Credit>`

    - `Commit`

    - `Credit`

  - **next\_page:** `string | null`

### Example

```node
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.contracts.listBalances({
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
  id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
  include_ledgers: true,
});

console.log(response.data);
```