---
title: "Get Payday Suggestion"
method: GET
path: "/api/payday/suggestion"
tags: ["Payday"]
deprecated: true
---

# Get Payday Suggestion

`GET /api/payday/suggestion`

## 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/payday/suggestion`
- Auth: HTTP bearer

> **Deprecated.**

Get allocation suggestion enriched with goals and budget performance.

Once the user has ACCEPTED a coach plan, the accepted plan is echoed
back unchanged (accepted=True) for the rest of the current pay cycle —
it is not regenerated on every fetch. A fresh suggestion is produced
again after the next payday has passed, so the plan updates once per
cycle rather than every time the tab opens.

## Response `200`

Successful Response

- PaydaySuggestionResponse
  - `summary` string, required
  - `next_payday` string, required
  - `monthly_income` number, required
  - `allocations` AllocationBreakdown[], required
    - `category` string, required
    - `amount` number, required
    - `percentage` number, required
  - `total_allocated` number, required
  - `remaining` number, required
  - `accepted` boolean
  - `cycle_review` CycleReview: How the previous pay cycle went against the accepted plan.
    - `period_start` string, required
    - `period_end` string, required
    - `headline` string, required
    - `entries` CycleReviewEntry[], required
      - `category` string, required
      - `planned` number, required
      - `actual` number, nullable
      - `delta` number, nullable
  - `goal_split` GoalSplit[]
    - `goal_id` string, required
    - `name` string, required
    - `amount` number, required
  - `goals_unplanned` GoalUnplanned[]
    - `goal_id` string, required
    - `name` string, required
    - `note` string
  - `buffer` CoachBuffer: The cash buffer the coach measures Savings against, in pounds (26 Sep 2026).
    - `cash_saved` number, required
    - `target` number, required
    - `months` number, required
    - `target_months` integer, required
  - `income_stale` boolean
  - `one_off_income_this_cycle` number
  - `incoming_this_cycle` number
  - `usual_spending` number
  - `bills_detail` BillsDetail: What the plan's Bills is made of (26 Sep 2026): how many recurring bills and subscriptions the coach counted, and the total it fixed.
    - `count` integer, required
    - `fixed_bills` number, required

---

[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)