# Retrieves a list of installment plans

Retrieve a list of installment plans that have been created for your account. The installment plans are sorted, with the most recent first.

Endpoint: GET /installment_plans
Version: v1
Security: apiKey

## Response 200 fields (application/json):

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

  - `data` (array, required)
    Example: [{"id":"PIV1QACRO4DSMQT0KK","type":"installment_plan","description":"Test installment plan","currency":"EUR","installment_plan_type":"direct_debit","state":"active","created_at":"2023-07-24T12:40:10Z","customer":"CU7JRN6W6K3DA9","mandate":"MDC7XX65BH42PW","period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"first_period":{"amount":"1000","vat":"21","multiplier":1,"interval":"month"},"number_of_periods":5,"payment_details":{"return_url":null,"cancel_url":null},"next_period_date":null,"metadata":{},"_links":{"self":"https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MDC7XX65BH42PW"}}]

  - `data.id` (string, required)
    Example: "PIV1QACRO4DSMQT0KK"

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

  - `data.description` (string, required)
    Example: "Test installment plan"

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

  - `data.state` (string, required)
    Example: "active"

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

  - `data.created_at` (string, required)
    Example: "2023-07-24T12:40:10Z"

  - `data.customer` (string,null, required)
    Example: "CU7JRN6W6K3DA9"

  - `data.mandate` (string,null, required)
    Example: "MDC7XX65BH42PW"

  - `data.period` (object, required)
    Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}

  - `data.period.amount` (integer, required)
    Example: "1000"

  - `data.period.vat` (number, required)
    Example: "21"

  - `data.period.multiplier` (integer, required)
    Example: 1

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

  - `data.first_period` (object,null, required)
    Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}

  - `data.first_period.amount` (integer, required)
    Example: "1000"

  - `data.first_period.vat` (number, required)
    Example: "21"

  - `data.first_period.multiplier` (integer)
    Example: 1

  - `data.first_period.interval` (string)
    Enum: same as `data.period.interval` (4 values)

  - `data.number_of_periods` (number, required)
    Example: 5

  - `data.payment_details` (object, required)
    Example: {"return_url":null,"cancel_url":null}

  - `data.payment_details.return_url` (string,null, required)

  - `data.payment_details.cancel_url` (string,null, required)

  - `data.next_period_date` (string,null, required)

  - `data.metadata` (object, required)
    Example: {}

  - `data._links` (object, required)
    Example: {"self":"https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MDC7XX65BH42PW"}

  - `data._links.self` (string, required)
    Example: "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK"

  - `data._links.customer` (string)
    Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"

  - `data._links.mandate` (string)
    Example: "https://api.paypro.nl/mandates/MDC7XX65BH42PW"

  - `data._links.checkout` (string)

  - `count` (integer, required)

  - `_links` (object, required)

  - `_links.self` (string, required)

  - `_links.next` (string)

  - `_links.prev` (string)