## List Charges

`client.v1.plans.listCharges(PlanListChargesParamsparams, RequestOptionsoptions?): CursorPage<PlanListChargesResponse>`

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

Fetches a list of charges of a specific plan.

### Parameters

- **params:** `PlanListChargesParams`

  - **plan\_id:** `string`

    Path param:

  - **limit:** `number`

    Query param: Max number of results that should be returned

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

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

### Returns

- `PlanListChargesResponse`
  - **id:** `string`

  - **charge\_type:** `"usage" | "fixed" | "composite" | 2 more`

    - `"usage"`

    - `"fixed"`

    - `"composite"`

    - `"minimum"`

    - `"seat"`

  - **credit\_type:** `CreditTypeData`

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

  - **name:** `string`

  - **prices:** `Array<Price>`

    - **tier:** `number`

      Used in pricing tiers.  Indicates at what metric value the price applies.

    - **value:** `number`

    - **collection\_interval:** `number`

    - **collection\_schedule:** `string`

    - **quantity:** `number`

  - **product\_id:** `string`

  - **product\_name:** `string`

  - **quantity:** `number`

  - **start\_period:** `number`

    Used in price ramps.  Indicates how many billing periods pass before the charge applies.

  - **tier\_reset\_frequency:** `number`

    Used in pricing tiers.  Indicates how often the tier resets. Default is 1 - the tier count resets every billing period.

  - **unit\_conversion:** `UnitConversion`

    Specifies how quantities for usage based charges will be converted.

    - **division\_factor:** `number`

      The conversion factor

    - **rounding\_behavior:** `"floor" | "ceiling"`

      Whether usage should be rounded down or up to the nearest whole number. If null, quantity will be rounded to 20 decimal places.

      - `"floor"`

      - `"ceiling"`

### Example

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

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

// Automatically fetches more pages as needed.
for await (const planListChargesResponse of client.v1.plans.listCharges({
  plan_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
})) {
  console.log(planListChargesResponse.id);
}
```