# Plans

## List

**get** `/v1/plans`

List all available plans.

### Returns

- **data:** `array of object`

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

## Get Details

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

Fetch high level details of a specific plan.

### Returns

- **data:** `PlanDetail`

## List Charges

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

Fetches a list of charges of a specific plan.

### Returns

- **data:** `array of object`

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

## List Customers

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

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

### Returns

- **data:** `array of object`

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

## Domain Types

### Plan Detail

- **PlanDetail:** `object`

  - **id:** `string`

  - **custom\_fields:** `map[string]`

  - **name:** `string`

  - **credit\_grants:** `array of object`

    - **amount\_granted:** `number`

    - **amount\_granted\_credit\_type:** `CreditTypeData`

    - **amount\_paid:** `number`

    - **amount\_paid\_credit\_type:** `CreditTypeData`

    - **effective\_duration:** `number`

    - **name:** `string`

    - **priority:** `string`

    - **send\_invoice:** `boolean`

    - **reason:** `string`

    - **recurrence\_duration:** `number`

    - **recurrence\_interval:** `number`

  - **description:** `string`

  - **minimums:** `array of object`

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

    - **name:** `string`

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

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

    - **value:** `number`

  - **overage\_rates:** `array of object`

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

    - **fiat\_credit\_type:** `CreditTypeData`

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

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

    - **to\_fiat\_conversion\_factor:** `number`