Schema
Database schema for the invite plugin.
Invite
| Field Name | Type | Key | Description |
|---|---|---|---|
| token | string | Unique token identifying this invite | |
| createdAt | Date | - | Date when the invite was created |
| expiresAt | Date | - | Date when the invite expires |
| maxUses | number | - | Maximum number of times this invite can be used |
| createdByUserId | string | ID of the user who created the invite | |
| redirectToAfterUpgrade | string | - | URL to redirect after the user upgrades |
| shareInviterName | boolean | - | Whether to share the inviter's name with the invitee |
| string | Optional email associated with this invite | ||
| role | string | - | Role assigned when the invite is used |
| newAccount | boolean | - | Whether this invite is for creating a new account or upgrading an existing one |
InviteUse
| Field Name | Type | Key | Description |
|---|---|---|---|
| inviteId | string | ID of the invite being used | |
| usedAt | Date | - | Date when the invite was used |
| usedByUserId | string | Optional ID of the user who used the invite |
How is this guide?
Last updated on