List Recurring Transactions
Lists the household's recurring income and expense series ordered by name, optionally filtered by status or merchant.
Both active and cancelled series are included when status is omitted. The response contains schedule definitions without pagination; use the occurrences endpoints for expected dates and matched transactions.
Authorization
PersonalApiToken Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.
In: header
Path Parameters
Query Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/households/string/recurring-transactions"{ "recurring_transactions": [ { "id": "Rt6wP4dM8xNc", "merchant": { "id": "Mr9dL3xT6bQa", "name": "Blue Bottle Coffee", "website": "https://www.bluebottlecoffee.com/", "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png", "default_image_url": "https://cdn.penny.finance/merchants/default-coffee.png" }, "name": "Netflix", "amount": { "amount": "68.42", "currency": "USD" }, "type": "income", "frequency": "every_week", "start_date": "2019-08-24", "status": "active", "end_date": "2019-08-24", "notes": "Standard monthly plan" } ]}Update Rule PUT
Replaces all matching conditions and actions of an existing rule while preserving its position in the priority order. Omitted fields reset to their schema…
Create Recurring Transaction POST
Creates a recurring income or expense series for a household merchant. This defines an expected schedule; it does not initiate payments or create financial…