Skip to main content
GET
/
cases
/
{case_id}
/
bank-accounts
/
{account_id}
/
recurring-payments
List recurring payments
curl --request GET \
  --url https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/recurring-payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01K6RP04DJ2T99HRYE78AN7YZA",
      "payee_name": "Springfield Electric Co.",
      "type": "utility",
      "amount": 150,
      "frequency": "monthly",
      "next_payment_date": "2025-10-15",
      "last_payment_date": "2025-09-15",
      "status": "active",
      "cancellation_date": "2023-12-25",
      "cancelled_by": "<string>",
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://api.hellosunset.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
account_id
string
required

Query Parameters

​
page
integer
default:1

Page number for pagination.

Required range: x >= 1
​
per_page
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
active,
cancelled,
paused,
transferred
​
type
enum<string>
Available options:
direct_deposit,
autopay,
subscription,
loan_payment,
insurance_premium,
utility,
pension,
social_security,
annuity

Response

List of recurring payments.

​
data
object[]
​
meta
object