# List payments within a payment plan

Returns a paginated list of payments that belong to the given payment plan.

Endpoint: GET /payment-plans/{paymentPlanId}/payments
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

## Path parameters:

  - `paymentPlanId` (string, required)
    The Id of payment plan

## Query parameters:

  - `Page` (integer)
    Specifies page number

## Response 200:

  - `200` (unknown)
    Payments successfully retrieved

## Response 200 fields (application/json):

  - `totalNumberOfPages` (integer)
    Total number of pages.

  - `totalNumberOfItems` (integer)
    Total number of items.

  - `page` (integer)
    Current page number.

  - `pageSize` (integer)
    Page size used by backend.

  - `data` (array)
    List of payments within the payment plan.

  - `data.payId` (string)
    PayID of the payment created within the payment plan.

  - `data.status` (string)
    Status of the payment (as returned by backend).

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

  - `data.amount.value` (integer)
    Value of the amount.

  - `data.amount.currency` (string)
    Currency of the amount.

  - `data.billingDate` (any)
    Billing/creation date of the payment in ISO 8601 format.

## 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)