admin

Admin Grant Plan

Grant a client any plan for free, with no expiry (comped plan).

Sets subscription_plan + plan_comped=True + guarantee_status=active, clears any pilot expiry (a comp supersedes a time-boxed pilot), starts a fresh billing cycle, and refills the plan's monthly credits. Logged as an admin_grant BillingEvent (amount = credit COUNT, not dollars) + audit row. Idempotent on Idempotency-Key.

post/api/v1/admin/clients/{client_id}/grant-plan

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-plan
  • Auth: HTTP bearer

Path parameters

client_idstring uuid required

Headers

Idempotency-Keystring nullable

Request body

plan'solo' | 'starter' | 'growth' | 'scale' required
reasonstring required

Response

Successful Response

client_idstring uuid required
planstring required
compedboolean required
credits_grantedinteger required
new_balanceinteger required
billing_event_idstring uuid required
sequences_resumedinteger

Changes

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