## List

`client.v1.plans.list(PlanListParamsquery?, RequestOptionsoptions?): CursorPage<PlanListResponse>`

**get** `/v1/plans`

List all available plans.

### Parameters

- **query:** `PlanListParams`

  - **limit:** `number`

    Max number of results that should be returned

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

    Cursor that indicates where the next page of results should start.

### Returns

- `PlanListResponse`
  - **id:** `string`

  - **description:** `string`

  - **name:** `string`

  - **custom\_fields:** `Record<string, string>`

### Example

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

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

// Automatically fetches more pages as needed.
for await (const planListResponse of client.v1.plans.list()) {
  console.log(planListResponse.id);
}
```