---
title: "Annual plan upgrade nudge data"
method: GET
path: "/api/subscription/nudge"
tags: ["subscribe"]
---

# Annual plan upgrade nudge data

`GET /api/subscription/nudge`

## Request

- Base URL: `https://api.equity-rank.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.equity-rank.com/api/subscription/nudge`
- Auth: HTTP bearer

Returns nudge data for the annual plan upgrade banner.
show_nudge=True only when user is on a monthly plan (active or trialing).
Annual and cancelled users get show_nudge=False.

## Response `200`

Successful Response

- object

---

[API](https://skmtc.dev/equity-rank/apis/equity-rank-api.md) · [All operations](https://skmtc.dev/equity-rank/apis/equity-rank-api/llms.txt) · [OpenAPI document](https://skmtc.dev/equity-rank/apis/equity-rank-api/revisions/c2f2463fee33?raw)