# Get list of payment plans for customer

Get list of payment plans for customer

Endpoint: GET /customers/{customerId}/payment-plans
Version: 2.7.0
Security: bearer, basic, apiKey

## Security:

  - `bearer` (unknown)
    http bearer JWT

  - `basic` (unknown)
    http basic

  - `apiKey` (unknown)
    apiKey in header X-API-Key

## Path parameters:

  - `customerId` (string, required)
    Customer Id

## Query parameters:

  - `page` (integer)

## Response 200:

  - `200` (unknown)
    Payment plans successfully retrieved

## Response 200 fields (application/json):

  - `totalNumberOfPages` (integer)
    Indicates total number of pages that exist.

  - `totalNumberOfItems` (integer)
    Indicates total number of items that exist.

  - `page` (integer)
    Indicates number of page that is retrieved.

  - `pageSize` (integer)
    Indicates max number of items on page.

  - `data` (array)

  - `data.id` (string)
    Unique identifier of the payment plan.

  - `data.paymentPlanType` (string)
    Payment plan type
    Enum: "RECURRING", "INSTALLMENTS", "DELAYED_SHIPMENT", "UNSCHEDULED_MIT"

  - `data.amount` (object)
    Amount object of the payment plan.

  - `data.amount.value` (integer)
    Total order amount in the smallest currency unit, including taxes, shipping costs, discounts, etc.

  - `data.amount.currency` (string)
    3-character ISO currency code.

  - `data.planStatus` (string)
    Status of the payment plan.
    Enum: "ACTIVE", "CANCELLED", "INVALID", "COMPLETED", "RETRY"

  - `data.description` (string)

  - `data.frequency` (string)
    Enum: "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY", "MONTHLY_EOM", "BIMONTHLY", "QUARTERLY", "YEARLY"

  - `data.creationDate` (string)

## Response 500:

  - `500` (unknown)
    Internal Server Error

## Response 500 fields (application/json):

  - `type` (string)

  - `title` (string)

  - `status` (string)

  - `detail` (string)

  - `instance` (string)

## Response 200 examples:

  - `Default` (unknown)

