---
title: "List payment plans"
method: GET
path: "/payment_plans"
---

# List payment plans

`GET /payment_plans`

## Request

- Base URL: `https://gateway.pmnts-sandbox.io/v1.0`
- URL: `https://gateway.pmnts-sandbox.io/v1.0/payment_plans`
- Auth: HTTP basic

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `offset` integer
- `limit` integer

## Response `200`

200

- object
  - `successful` boolean
  - `response` object[]
    - `id` string
    - `customer` string
    - `amount` integer
    - `currency` unknown
    - `setup_fee` integer
    - `frequency` string
    - `anniversary` integer
    - `start_date` string
    - `end_date` unknown
    - `total_count` integer
    - `total_amount` unknown
    - `payment_method` string
    - `reference` string
    - `description` unknown
    - `status` string
    - `status_reason` string
    - `created_at` string
    - `failed_payment_fee` integer
    - `retry_interval` integer
    - `status_change_date` unknown
    - `payments` unknown[]
      - unknown
  - `errors` unknown[]
    - unknown
  - `test` boolean
  - `records` integer
  - `total_records` integer
  - `page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `a62ddbae3800`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fatzebra/apis/gateway/changes/payment_plans/get.md)

---

[API](https://skmtc.dev/fatzebra/apis/gateway.md) - [All operations](https://skmtc.dev/fatzebra/apis/gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/fatzebra/apis/gateway/revisions/a62ddbae3800?raw)