---
title: "Fetch a payment plan"
method: GET
path: "/payment_plans/{id_or_reference}"
---

# Fetch a payment plan

`GET /payment_plans/{id_or_reference}`

## Request

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

## Path parameters

- `id_or_reference` string, required

## 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` object[]
      - `id` string
      - `payment_plan` string
      - `reference` string
      - `amount` integer
      - `currency` unknown
      - `scheduled_date` string
      - `payment_method` string
      - `status` string
      - `result` unknown
      - `records` unknown[]
        - unknown
  - `errors` unknown[]
    - unknown
  - `test` boolean

## Other responses

- `404`: 404

## Changes

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

[Operation history](https://skmtc.dev/fatzebra/apis/gateway/changes/payment_plans/:id_or_reference/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)