---
title: "List recurring payments"
method: GET
path: "/cases/{case_id}/bank-accounts/{account_id}/recurring-payments"
tags: ["Recurring Payments"]
---

# List recurring payments

`GET /cases/{case_id}/bank-accounts/{account_id}/recurring-payments`

## Request

- Base URL: `https://api.example.com/v1`
- URL: `https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/recurring-payments`
- Auth: none declared

List all recurring payments and deposits for a bank account.

## Query parameters

- `page` integer
- `per_page` integer
- `status` 'active' | 'cancelled' | 'paused' | 'transferred'
- `type` 'direct_deposit' | 'autopay' | 'subscription' | 'loan_payment' | 'insurance_premium' | 'utility' | 'pension' | 'social_security' | 'annuity'

## Response `200`

List of recurring payments.

- object
  - `data` RecurringPayment[]
    - `id` string
    - `payee_name` string
    - `type` 'direct_deposit' | 'autopay' | 'subscription' | 'loan_payment' | 'insurance_premium' | 'utility' | 'pension' | 'social_security' | 'annuity'
    - `amount` number, double
    - `frequency` 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'annually'
    - `next_payment_date` string, date, nullable
    - `last_payment_date` string, date, nullable
    - `status` 'active' | 'cancelled' | 'paused' | 'transferred'
    - `cancellation_date` string, date, nullable
    - `cancelled_by` string, nullable
    - `notes` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `meta` PaginationMeta
    - `page` integer
    - `per_page` integer
    - `total_count` integer
    - `total_pages` integer
    - `next_cursor` string, nullable: Opaque cursor for fetching the next page. Pass as the `cursor` query parameter. Null when on the last page.
    - `has_more` boolean: Whether more results exist beyond this page.

## Other responses

- `404`: Resource not found.

---

[API](https://skmtc.dev/hellosunset/apis/sunset-api.md) - [All operations](https://skmtc.dev/hellosunset/apis/sunset-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hellosunset/apis/sunset-api/revisions/f128e5526efe?raw)