admin

Admin Grant Pilot

Grant a free pilot plan to a client (no Stripe charge).

Sets subscription_plan + guarantee_status=pilot + pilot_start_at + pilot_expires_at (= now + free_days), refills the plan's monthly credit allowance, and logs an admin_grant BillingEvent (amount = the credit count granted, so the admin overview's granted-credits total reflects it) plus an AuditLog row. Idempotent on Idempotency-Key.

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

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

Path parameters

client_idstring uuid required

Headers

Idempotency-Keystring nullable

Request body

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

Response

Successful Response

client_idstring uuid required
planstring required
credits_grantedinteger required
new_balanceinteger required
pilot_expires_atstring date-time required
billing_event_idstring uuid required
sequences_resumedinteger

Changes

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