---
title: "Admin Grant Preview"
method: GET
path: "/api/v1/admin/clients/{client_id}/grant-preview"
tags: ["admin"]
---

# Admin Grant Preview

`GET /api/v1/admin/clients/{client_id}/grant-preview`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/admin/clients/{client_id}/grant-preview`
- Auth: HTTP bearer

Compute the before→after state + warnings for a proposed grant so the
confirmation UI can show consequences before anything is written. Performs
no mutation. ``amount`` is required for ``kind=credits``; ``plan`` for
``kind=pilot|plan``.

## Path parameters

- `client_id` string, uuid, required

## Query parameters

- `kind` 'credits' | 'pilot' | 'plan', required
- `amount` integer, nullable
- `plan` 'solo' | 'starter' | 'growth' | 'scale'
- `free_days` integer

## Response `200`

Successful Response

- GrantPreview
  - `client_id` string, uuid, required
  - `kind` string, required
  - `current_balance` integer, required
  - `current_included` integer, required
  - `current_plan` string, nullable, required
  - `current_comped` boolean, required
  - `current_guarantee` string, required
  - `has_stripe_subscription` boolean, required
  - `new_balance` integer, required
  - `new_included` integer, required
  - `balance_delta` integer, required
  - `surplus_lost` integer, required
  - `usd_value` number, required
  - `est_leads` integer, nullable, required
  - `resets_billing_cycle` boolean, required
  - `overwrites_plan` boolean, required
  - `pilot_expires_at` string, date-time, nullable, required
  - `warnings` string[], required
  - `blockers` string[], required

## Other responses

- `422`: Validation Error

---

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