Koo Docs
View as Markdown

Account

A Koo account — the tenant/workspace identity: handle, tier, profile, and social counts.

Attributes

AccountDto

A Koo account — the tenant/workspace identity: handle, tier, profile, and social counts.

idstringread-only

Account identifier.

handlestringrequired

Global-unique account handle — the URL/CLI slug.

tier"Free" | "Plus" | "Pro" | "Enterprise"read-only

The account’s plan, by display name. The internal Free sub-tiers all report `Free`.

status"active" | "suspended" | "pending_deletion" | "provisioning_pending" | "payment_pending"read-only

Account lifecycle status. `provisioning_pending`: the hosting environment is still being set up — deploys are paused until provisioning completes (retry via POST /accounts/:id/reprovision). `payment_pending`: a secondary account that has never been paid for — it has no hosting environment and every write is refused with 402 until a subscription starts.

deleteAtstring <date-time>read-only

Scheduled hard-delete time; set iff `status === 'pending_deletion'`.

isPrimarybooleanread-only

Whether this is the user's primary account (created during onboarding).

onboardingStateobjectread-only

The account's onboarding state machine position.

profileobjectrequired

Editable account profile (avatar, banner, bio, location, links).

countsobjectread-only

Denormalized social/app counts for this account.

createdAtstring <date-time>read-only

Account creation timestamp.

The Account object
json
{  "id": "acct_01example0000000000000000x",  "handle": "alice",  "tier": "Free",  "status": "active",  "deleteAt": "2026-01-01T00:00:00.000Z",  "isPrimary": true,  "onboardingState": {    "step": "SIGNED_IN",    "cliDeploy": {      "projectId": "project_01example0000000000000000x",      "environmentId": "environment_01example0000000000000000x",      "serviceId": "svc_01example0000000000000000x"    }  },  "profile": {    "displayName": "My app",    "avatarUrl": "https://example.com",    "bannerUrl": "https://example.com",    "bio": "example",    "location": "example",    "links": {      "key": "example"    }  },  "counts": {    "followers": 0,    "following": 0,    "apps": 0  },  "createdAt": "2026-01-01T00:00:00.000Z"}