admin

Admin Grant Preview

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.

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

Path parameters

client_idstring uuid required

Query parameters

kind'credits' | 'pilot' | 'plan' required
amountinteger nullable
plan'solo' | 'starter' | 'growth' | 'scale'
free_daysinteger

Response

Successful Response

client_idstring uuid required
kindstring required
current_balanceinteger required
current_includedinteger required
current_planstring nullable required
current_compedboolean required
current_guaranteestring required
has_stripe_subscriptionboolean required
new_balanceinteger required
new_includedinteger required
balance_deltainteger required
surplus_lostinteger required
usd_valuenumber required
est_leadsinteger nullable required
resets_billing_cycleboolean required
overwrites_planboolean required
pilot_expires_atstring date-time nullable required
warningsstring[] required
blockersstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.