Onboarding

Fields

Field	Type	Description
`workspace_id` *	string or null
`plan` *	`trial`, `hobby`, `pro`, `business`, `dedicated` or null
`plan_chosen` *	boolean
`trial_ends_at` *	string (date-time) or null
`card` *	object
`legal` *	object
`checklist` *	array of OnboardingStep
`completed_count` *	integer
`total_count` *	integer
`complete` *	boolean
`dismissed` *	boolean
`version` *	integer

* always present

Example

{
  "workspace_id": "string",
  "plan": "trial",
  "plan_chosen": false,
  "trial_ends_at": "2026-10-22T13:05:00Z",
  "card": {
    "required": false,
    "status": "not_required",
    "setup_url": "https://guv.dev/"
  },
  "legal": {
    "terms_version": "string",
    "privacy_version": "string",
    "accepted_terms_version": "string",
    "accepted_privacy_version": "string",
    "needs_acceptance": false
  },
  "checklist": [
    {
      "id": "create_project",
      "title": "string",
      "description": "string",
      "status": "pending",
      "source": "auto",
      "completed_at": "2026-10-22T13:05:00Z"
    }
  ],
  "completed_count": 1,
  "total_count": 1,
  "complete": false,
  "dismissed": false,
  "version": 1
}

Onboarding

Fields

Example

Used by