Pay schedule

Confirm Pay Schedule

Confirm (or edit) the pay schedule. Fields that don't belong to the chosen cadence are cleared, so switching cadence leaves nothing stale.

put/api/users/me/pay

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/users/me/pay
  • Auth: HTTP bearer

Request body

cadence'monthly' | 'twice_monthly' | 'weekly' | 'fortnightly' | 'four_weekly' | 'irregular' required
day_of_monthinteger nullable
second_dayinteger nullable
weekdayinteger nullable
anchorstring date nullable
irregular_frequency'roughly_monthly' | 'few_times_a_month' | 'varies' nullable
next_expectedstring date nullable
income_kind'salary' | 'freelancer' | 'student' | 'other' nullable

Response

Successful Response

confirmed_atstring date-time nullable
prefill_source'onboarding' | 'detection' | 'onboarding+detection' nullable
next_paydaystring date nullable
days_until_paydayinteger nullable
cycle_startstring date nullable
cycle_endstring date nullable
cadence_phrasestring nullable

Changes

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