Skip to main content
GET
/
account_holders
/
{id}
/
recurring
Get account holder recurring transactions
curl --request GET \
  --url https://api.ledgerbeam.com/v1/account_holders/{id}/recurring \
  --header 'API-KEY: <api-key>'
[
  {
    "id": "8efbac45-9bd5-4b67-be29-334106198c40",
    "start_date": "2024-03-01",
    "end_date": "2024-03-30",
    "total_amount": 300,
    "average_amount": 10,
    "periodicity_in_days": 1,
    "periodicity": "daily",
    "counterparty": {
      "type": "organization",
      "id": "d4bc3c80-ec1a-3da2-836e-2a4ca4758be5",
      "name": "Starbucks",
      "website": "starbucks.com",
      "logo": "https://logos.ledgerbeam.com/starbucks.com",
      "mccs": [
        5814
      ]
    },
    "categories": {
      "general": "coffee shop",
      "accounting": "operational expenses"
    },
    "transaction_ids": [
      "2dc6SE8A7cTQ2jUdUadCg",
      "tQYAhhl0XNkl1wasacpVQ",
      "NNJTqvockIdKnYxBqPlJw"
    ],
    "entry_type": "outgoing"
  }
]

​
Overview

Find recurring groups in a transaction history of the account holder. This endpoint identifies and categorizes recurring patterns such as periodic payments or subscriptions.
  • Subscription Management: Identify recurring subscriptions and payments
  • Budget Planning: Understand regular spending patterns
  • Financial Analysis: Analyze recurring income and expenses
  • Automation: Set up automated categorization for recurring transactions
  • Compliance: Track recurring payments for regulatory reporting

Authorizations

​
API-KEY
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Account holder ID

Response

Recurring groups retrieved successfully

​
id
string

A unique UUID identifier for the group

Example:

"8efbac45-9bd5-4b67-be29-334106198c40"

​
start_date
string<date>

The date of the oldest transaction in the group

Example:

"2024-03-01"

​
end_date
string<date>

The date of the most recent transaction in the group

Example:

"2024-03-30"

​
total_amount
number

The sum of all transaction amounts in this group

Example:

300

​
average_amount
number

The average amount per transaction in this group

Example:

10

​
periodicity_in_days
number

The estimated number of days between transactions in this group

Example:

1

​
periodicity
string

A human-readable description of the transaction frequency

Example:

"daily"

​
counterparty
object
​
categories
object
​
transaction_ids
string[]

Transactions in this recurrence group

Example:
[
  "2dc6SE8A7cTQ2jUdUadCg",
  "tQYAhhl0XNkl1wasacpVQ",
  "NNJTqvockIdKnYxBqPlJw"
]
​
entry_type
enum<string>

The direction of the flow of the money for the transactions within the group

Available options:
incoming,
outgoing
Example:

"outgoing"