# Pauses a installment plan

Pauses a installment plan. A paused installment plan will no longer create new installment plan periods.
You can resume the installment plan by calling the /installment_plans/:id/resume endpoint.

Endpoint: POST /installment_plans/{id}/pause
Version: v1
Security: apiKey

## Security:

  - `apiKey` (unknown)
    http bearer API key

## Path parameters:

  - `id` (string, required)
    ID of the installment plan

## Response 200:

  - `200` (unknown)
    installment plan paused

## Response 200 fields (application/json):

  - `id` (string, required)

  - `type` (string, required)
    Enum: "installment_plan"

  - `description` (string, required)

  - `installment_plan_type` (string, required)
    Enum: "direct_debit"

  - `state` (string, required)

  - `currency` (string, required)
    Enum: "EUR"

  - `created_at` (string, required)

  - `customer` (string, required)

  - `mandate` (string, required)

  - `period` (object, required)

  - `period.amount` (integer, required)

  - `period.vat` (number, required)

  - `period.multiplier` (integer, required)

  - `period.interval` (string, required)
    Enum: "day", "week", "month", "year"

  - `first_period` (object, required)

  - `first_period.amount` (integer, required)

  - `first_period.vat` (number, required)

  - `first_period.multiplier` (integer)

  - `first_period.interval` (string)
    Enum: "day", "week", "month", "year"

  - `number_of_periods` (number, required)

  - `payment_details` (object, required)

  - `payment_details.return_url` (string, required)

  - `payment_details.cancel_url` (string, required)

  - `next_period_date` (string, required)

  - `metadata` (object, required)

  - `_links` (object, required)

  - `_links.self` (string, required)

  - `_links.customer` (string)

  - `_links.mandate` (string)

  - `_links.checkout` (string)

