Penny Docs
Recurring transactions

Get Recurring Transaction Occurrences

GET
/v1/households/{household_id}/recurring-transactions/{recurring_transaction_id}/occurrences

Lists expected occurrences for one recurring series within an inclusive date range, including their status and matched transaction details.

Matching is coordinated across the household's series, so results agree with the household-wide occurrences endpoint when several series could match the same transaction. Returns recurring_transaction_not_found if the series does not belong to this household.

Authorization

PersonalApiToken
AuthorizationBearer <token>

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

household_id*Household Id
recurring_transaction_id*Recurring Transaction Id

Query Parameters

start_date*Start Date
Formatdate
end_date*End Date
Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/households/string/recurring-transactions/string/occurrences?start_date=2019-08-24&end_date=2019-08-24"
{  "occurrences": [    {      "recurring_transaction_id": "Rt6wP4dM8xNc",      "name": "Netflix",      "expected_date": "2019-08-24",      "expected_amount": {        "amount": "68.42",        "currency": "USD"      },      "type": "income",      "status": "paid",      "transaction_id": "Tx3fJ9mS6vBa",      "transaction_amount": {        "amount": "68.42",        "currency": "USD"      },      "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"      }    }  ]}

Get Occurrences GET

Lists expected recurring income and expense occurrences within an inclusive date range, with their status and any matched transaction details. Occurrences…

Get Suggestions GET

Detects candidate recurring series from the household's transaction history and returns suggested merchants, amounts, frequencies, and supporting details.…