---
title: "Confirm Pay Schedule"
method: PUT
path: "/api/users/me/pay"
tags: ["Pay schedule"]
---

# Confirm Pay Schedule

`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

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

## Request body

- PayScheduleBody
  - `cadence` 'monthly' | 'twice_monthly' | 'weekly' | 'fortnightly' | 'four_weekly' | 'irregular', required
  - `amount` union, required
    - number
    - string
  - `day_of_month` integer, nullable
  - `second_day` integer, nullable
  - `weekday` integer, nullable
  - `anchor` string, date, nullable
  - `irregular_frequency` 'roughly_monthly' | 'few_times_a_month' | 'varies', nullable
  - `next_expected` string, date, nullable
  - `income_kind` 'salary' | 'freelancer' | 'student' | 'other', nullable

## Response `200`

Successful Response

- PayScheduleResponse
  - `confirmed` PayScheduleOut
    - `cadence` 'monthly' | 'twice_monthly' | 'weekly' | 'fortnightly' | 'four_weekly' | 'irregular', required
    - `amount` string, nullable
    - `day_of_month` integer, nullable
    - `second_day` integer, nullable
    - `weekday` integer, nullable
    - `anchor` string, date, nullable
    - `irregular_frequency` 'roughly_monthly' | 'few_times_a_month' | 'varies', nullable
    - `next_expected` string, date, nullable
    - `income_kind` 'salary' | 'freelancer' | 'student' | 'other', nullable
  - `confirmed_at` string, date-time, nullable
  - `prefill` PayScheduleOut
    - `cadence` 'monthly' | 'twice_monthly' | 'weekly' | 'fortnightly' | 'four_weekly' | 'irregular', required
    - `amount` string, nullable
    - `day_of_month` integer, nullable
    - `second_day` integer, nullable
    - `weekday` integer, nullable
    - `anchor` string, date, nullable
    - `irregular_frequency` 'roughly_monthly' | 'few_times_a_month' | 'varies', nullable
    - `next_expected` string, date, nullable
    - `income_kind` 'salary' | 'freelancer' | 'student' | 'other', nullable
  - `prefill_source` 'onboarding' | 'detection' | 'onboarding+detection', nullable
  - `suggestion` PaySuggestion: What detection noticed — shown as "we noticed £X from Y, use this?".
    - `source_name` string, required
    - `amount` string, required
    - `cadence` 'monthly' | 'twice_monthly' | 'weekly' | 'fortnightly' | 'four_weekly' | 'irregular', required
    - `occurrences` integer, required
    - `last_date` string, date, nullable
  - `next_payday` string, date, nullable
  - `days_until_payday` integer, nullable
  - `cycle_start` string, date, nullable
  - `cycle_end` string, date, nullable
  - `cadence_phrase` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)