# Get list of payment plans

Get list of payment plans

Endpoint: GET /payment-plans
Version: 2.6.0
Security: bearer, basic, apiKey

## Security:

  - `bearer` (unknown)
    http bearer JWT

  - `basic` (unknown)
    http basic

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

## Query parameters:

  - `Page` (integer)
    Specifies page number

  - `CreatedAtFrom` (any)
    The createdAt date time lower limit

  - `CreatedAtTo` (any)
    The createdAt date time upper limit

  - `LastBillingFrom` (any)
    The last billing date time lower limit

  - `LastBillingTo` (any)
    The last billing date time upper limit

  - `PaymentPlanId` (string)
    The Id of payment plan

  - `MerchantCustomerId` (string)
    The merchant customer id

  - `Currency` (string)
    Currency

  - `AmountFrom` (integer)
    Lower limit of the amount

  - `AmountTo` (integer)
    Upper limit of the amount

  - `Amount` (integer)
    Exact amount value

  - `PlanStatus` (string)
    Payment plan status

  - `PlanType` (string)
    Payment plan status

## 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.lastBillingDate` (any)
    Last billing date of the payment plan in ISO 8601 format.

  - `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.merchantCustomerId` (string)
    Unique identifier of the customer assigned by merchant.

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

  - `data.description` (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)