## List Customers

`v1.plans.list_customers(PlanListCustomersParams**kwargs)  -> SyncCursorPage[PlanListCustomersResponse]`

**get** `/v1/planDetails/{plan_id}/customers`

Fetches a list of customers on a specific plan (by default, only currently active plans are included)

### Parameters

- **plan\_id:** `str`

- **limit:** `int`

  Max number of results that should be returned

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

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

- **status:** `Literal["all", "active", "ended", "upcoming"]`

  Status of customers on a given plan. Defaults to `active`.

  * `all` - Return current, past, and upcoming customers of the plan.
  * `active` - Return current customers of the plan.
  * `ended` - Return past customers of the plan.
  * `upcoming` - Return upcoming customers of the plan.

  Multiple statuses can be OR'd together using commas, e.g. `active,ended`.
  **Note:** `ended,upcoming` combination is not yet supported.

  - `"all"`

  - `"active"`

  - `"ended"`

  - `"upcoming"`

### Returns

- `class PlanListCustomersResponse`

  - **customer\_details:** `CustomerDetail`

  - **plan\_details:** `PlanDetails`

    - **id:** `str`

    - **custom\_fields:** `Dict[str, str]`

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

    - **name:** `str`

    - **starting\_on:** `datetime`

      The start date of the plan

    - **ending\_before:** `Optional[datetime]`

      The end date of the plan

### Example

```python
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
page = client.v1.plans.list_customers(
    plan_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
)
page = page.data[0]
print(page.customer_details)
```