Bills

Upsert Recurring Preference

Create or update a recurring preference (upsert by merchant_name).

Stage A rule 4: this is the ONE write behind every user edit — "not a bill" (override_type=not_recurring), an amount/frequency edit (bill|subscription + amount/frequency), a manual add (source=manual) and a section move. A real SQL upsert keyed by user + merchant, so the mobile outbox can replay it after being offline; every call also records a recurring_review_events row (once per client_id) and re-runs the analysis so /latest, Home, Payday and budget onboarding reflect the edit now rather than after the next bank sync.

post/api/bills/recurring-preferences

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/bills/recurring-preferences
  • Auth: HTTP bearer

Request body

merchant_namestring required
override_type'bill' | 'subscription' | 'habit' | 'not_recurring' required
amountnumber nullable
frequencystring nullable
sourcestring
display_namestring nullable
client_idstring nullable
surfacestring nullable

Response

Successful Response

idstring required
merchant_namestring required
override_typestring required
created_atstring required
updated_atstring required
amountnumber nullable
frequencystring nullable
sourcestring
display_namestring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.