## List Balances

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

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

List balances (commits and credits).

### Parameters

- **customer\_id:** `str`

- **id:** `str`

- **covering\_date:** `Union[str, datetime]`

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

- **effective\_before:** `Union[str, datetime]`

  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:** `int`

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

- **next\_page:** `str`

  The next page token from a previous response.

- **starting\_at:** `Union[str, datetime]`

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

### Returns

- `class ContractListBalancesResponse`

  - **data:** `List[Data]`

    - `Commit`

    - `Credit`

  - **next\_page:** `Optional[str]`

### Example

```python
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v1.contracts.list_balances(
    customer_id="13117714-3f05-48e5-a6e9-a66093f13b4d",
    id="6162d87b-e5db-4a33-b7f2-76ce6ead4e85",
    include_ledgers=True,
)
print(response.data)
```