Saavo

DB

All tables and fields in the main application database.

DB is the default template's application database. Its initial schema is defined in schema/db-init.sql. This reference covers account, authentication, OAuth 2.0, permission, payment, support ticket, notification, affiliate, and Reaction data by table, including field types, nullability, defaults, and database constraints.

Time and boolean values

Time fields use Unix timestamps in milliseconds. Boolean states are stored as SQLite INTEGER values, typically using 1 for true and 0 for false.

ticket

Stores support ticket lookup fields and status. Ticket bodies are stored in MAIN_KV and linked through kv_id.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
requester_idINTEGERNo——ID of the user who submitted the ticket. A value less than or equal to 0 indicates an anonymous requester.
assignee_idINTEGERYes——ID of the admin user responsible for handling the ticket.
kv_idTEXTNo——Unique key for the ticket body in MAIN_KV.
statusTEXTNo'open'—Current status.
priorityINTEGERNo0—Priority. Higher values indicate higher priority.
ticket_typeTEXTYes——Ticket type.
productTEXTYes——Product associated with the ticket.
titleTEXTYes——Title.
nameTEXTYes——Name.
emailTEXTYes——Email address.
requester_unreadINTEGERNo0—Whether the requester has unread replies. 1 means yes, and 0 means no.
closed_atINTEGERYes——Ticket closure time, in Unix milliseconds.
resolved_atINTEGERYes——Ticket resolution time, in Unix milliseconds.
deleted_atINTEGERNo0—Soft deletion time. 0 means not deleted.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

newsletter_subscriber

Stores newsletter email addresses, locales, and subscription times.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
emailTEXTNo——Email address.
localeTEXTNo——Language code.
subscribed_atINTEGERNoCurrent Unix time in milliseconds—Time of subscription to the mailing list, in Unix milliseconds.

saas_user

Stores user accounts, sign-in providers, two-factor authentication, and affiliate status.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
emailTEXTYes——Email address.
email_hashTEXTNo——Hash of the normalized email address, used for uniqueness checks and secure queries.
email_verifiedINTEGERNo0—Whether the email address has been verified. 1 means verified.
user_nameTEXTNo——Username.
display_nameTEXTYes——Display name.
password_hashTEXTYes——Password hash. Empty when the user signs in through a third-party provider and has not set a password.
account_idTEXTYes——Account ID returned by the sign-in provider.
image_urlTEXTYes——Avatar URL.
blog_urlTEXTYes——User homepage or blog URL.
providerTEXTNo'email'—Account sign-in provider.
two_factor_enabledINTEGERNo0—Whether two-factor authentication is enabled. 1 means enabled.
totp_keyBLOBYes——Encrypted TOTP secret.
recovery_codesJSONNo'[]'—Array of recovery code hashes.
recovery_codes_generated_atINTEGERNo0—Most recent recovery code generation time, in Unix milliseconds.
deleted_atINTEGERNo0—Soft deletion time. 0 means not deleted.
deleted_reasonTEXTYes——Reason for soft deletion.
disabled_atINTEGERNo0—Disable time. 0 means not disabled.
disabled_reasonTEXTYes——Reason for disabling.
disabled_expires_atINTEGERNo0—End time of a temporary suspension. 0 means no end time is set.
invited_by_idINTEGERYes——User ID of the affiliate who invited this user.
own_referral_codeTEXTNo——Unique referral code assigned to this user.
affiliate_enabled_atINTEGERNo0—Time affiliate participation was enabled. 0 means not enabled.
affiliate_disabled_atINTEGERNo0—Time affiliate participation was disabled. 0 means not disabled.
affiliate_disabled_reasonTEXTYes——Reason for disabling affiliate participation.
affiliate_disabled_by_idINTEGERYes——ID of the admin user who disabled it.
referral_statusTEXTYes——Referral eligibility status.
referral_status_reasonTEXTYes——Reason for the referral eligibility status change.
referral_status_changed_atINTEGERNo0—Most recent referral eligibility status change time. 0 means not yet recorded.
referral_status_changed_by_idINTEGERYes——ID of the admin user who changed the referral eligibility status.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

notification

Stores in-app notification content, audience, publication status, and counts.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
audience_typeTEXTNo——Notification audience type: all users or selected users.
recipient_countINTEGERNo0—Number of target users.
read_countINTEGERNo0—Number of users who have read the notification.
titleTEXTNo——Title.
summaryTEXTNo——Summary.
messageJSONNo——Structured notification content.
statusTEXTNo——Current status.
created_by_user_idINTEGERYes——ID of the admin user who created this record.
published_atINTEGERYes——Notification publication time, in Unix milliseconds.
expires_atINTEGERYes——Expiration time, in Unix milliseconds.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

user_notification

Stores each user's read and dismissal status for a notification, along with a concurrency control marker for updating the read count.

FieldTypeNullableDefaultKeyDescription
user_idINTEGERNo—PK (composite)User ID.
notification_idTEXTNo—PK (composite)Notification ID.
read_atINTEGERYes——Time the user read the notification, in Unix milliseconds.
dismissed_atINTEGERYes——Time the user dismissed the notification, in Unix milliseconds.
read_claim_idTEXTYes——Unique identifier used for concurrent updates to the read count.

affiliate_payout_profiles

Stores encrypted affiliate payout details.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
user_idINTEGERNo——User ID.
payment_methodTEXTNo——Payout method.
encrypted_detailsBLOBNo——Encrypted payout details.
payment_account_fingerprintTEXTNo——Payout account fingerprint used to detect duplicate details.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.

affiliate_commissions

Stores the source, calculation snapshot, and validity status of each referral commission.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
affiliate_user_idINTEGERNo——User ID of the affiliate receiving the commission or settlement payment.
referred_user_idINTEGERNo——ID of the user who signed up or purchased through a referral.
product_idTEXTNo——Product key from config/products.ts.
plan_idTEXTNo——Plan key from config/products.ts.
providerTEXTNo——Payment provider that generated the commission.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
transaction_idTEXTNo——Transaction ID.
transaction_item_idTEXTNo——Transaction line item ID.
provider_line_item_idTEXTNo——Line item ID in the payment provider.
provider_price_idTEXTYes——Price ID in the payment provider.
transaction_statusTEXTNo——Transaction status recorded when the commission was generated.
payment_kindTEXTNo——Payment type: one-time or subscription payment.
subscription_idTEXTYes——Subscription ID.
quantityINTEGERYes——Quantity.
unit_amount_minorINTEGERYes——Unit price, in the currency's smallest unit.
unit_amount_decimalTEXTYes——High-precision unit price string returned by the payment provider.
subtotal_minorINTEGERYes——Subtotal before discounts and taxes, in the currency's smallest unit.
discount_minorINTEGERYes——Discount amount, in the currency's smallest unit.
tax_minorINTEGERYes——Tax amount, in the currency's smallest unit.
total_minorINTEGERNo——Total amount, in the currency's smallest unit.
currencyTEXTNo——Currency code.
calculation_typeTEXTNo——Commission calculation method: fixed amount or percentage.
percentage_basis_pointsINTEGERYes——Commission rate in basis points. 10000 means 100%.
percentage_baseTEXTYes——Amount basis used to calculate percentage commissions.
fixed_amount_minorINTEGERYes——Fixed commission amount, in the currency's smallest unit.
fixed_currencyTEXTYes——Currency for fixed commissions.
statusTEXTNo'valid'—Current status.
status_reason_codeTEXTYes——Reason code for commission invalidation or refund.
status_reasonTEXTYes——Reason supplied when using a custom reason code.
status_internal_noteTEXTYes——Status note visible only in the admin dashboard.
status_changed_atINTEGERNo0—Most recent status change time. 0 means not yet recorded.
status_changed_by_idINTEGERYes——ID of the admin user who changed the status.
earned_atINTEGERYes——Commission confirmation time, in Unix milliseconds.
available_atINTEGERYes——Time the commission became available for settlement, in Unix milliseconds.
deleted_atINTEGERNo0—Soft deletion time. 0 means not deleted.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.

affiliate_monthly_payouts

Aggregates commissions and payment status by affiliate, month, and currency.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
affiliate_user_idINTEGERNo——User ID of the affiliate receiving the commission or settlement payment.
period_startINTEGERNo——Start of the settlement month, in Unix milliseconds.
currencyTEXTNo——Currency code.
calculated_referred_user_countINTEGERNo0—Number of referred users included in this period's settlement.
calculated_commission_countINTEGERNo0—Total number of commission records for this period.
calculated_valid_countINTEGERNo0—Number of valid commission records for this period.
calculated_refunded_countINTEGERNo0—Number of refunded commission records for this period.
calculated_invalid_countINTEGERNo0—Number of invalid commission records for this period.
calculated_total_payment_amount_minorINTEGERNo0—Total payment amount for this period, in the currency's smallest unit.
calculated_valid_payment_amount_minorINTEGERNo0—Payment amount that generated valid commissions, in the currency's smallest unit.
calculated_valid_commission_amount_minorINTEGERNo0—Valid commission amount for this period, in the currency's smallest unit.
calculated_refunded_commission_amount_minorINTEGERNo0—Refunded commission amount for this period, in the currency's smallest unit.
calculated_invalid_commission_amount_minorINTEGERNo0—Invalid commission amount for this period, in the currency's smallest unit.
calculation_changed_atINTEGERNo0—Most recent settlement amount change time.
statusTEXTNo'draft'—Current status.
requested_atINTEGERNo0—Time the settlement request was submitted. 0 means not yet requested.
actual_paid_amount_minorINTEGERYes——Actual amount paid, in the currency's smallest unit.
paid_atINTEGERNo0—Actual payment time for the monthly settlement. 0 means not yet paid.
paid_by_idINTEGERYes——ID of the admin user who recorded the payment.
email_content_jsonJSONYes——Content snapshot of the settlement notification email.
send_emailINTEGERNo0—Whether to send a settlement notification email. 1 means send.
email_sent_atINTEGERNo0—Time the settlement notification email was sent successfully. 0 means not yet sent.
email_failure_reasonTEXTYes——Reason the settlement notification email failed to send.
manual_updated_atINTEGERNo0—Time the settlement record was manually edited in the admin dashboard. 0 means not edited.
manual_updated_by_idINTEGERYes——ID of the admin user who made the manual edit.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.

affiliate_monthly_payout_records

Stores each actual payment for a monthly settlement, along with a snapshot of the payout details.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
monthly_payout_idINTEGERNo——Monthly settlement record ID.
revisionINTEGERNo——Payment record version within the same monthly settlement.
calculated_amount_minorINTEGERNo——Amount due calculated when the payment was recorded, in the currency's smallest unit.
calculation_changed_atINTEGERNo——Most recent settlement amount change time.
actual_paid_amount_minorINTEGERNo——Actual amount paid, in the currency's smallest unit.
difference_reasonTEXTNo''—Reason the actual payment differs from the calculated amount.
internal_noteTEXTNo''—Note visible only in the admin dashboard.
paid_atINTEGERNo——Time this payment actually occurred, in Unix milliseconds.
encrypted_payout_profileBLOBNo——Encrypted snapshot of the payout details used for the payment.
saved_atINTEGERNo——Time the payment record was saved, in Unix milliseconds.
saved_by_idINTEGERNo——ID of the admin user who saved the payment record.

saas_session

Stores user sign-in sessions, expiration times, and recent activity information.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idINTEGERNo——User ID.
expires_atINTEGERNo——Expiration time, in Unix milliseconds.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
last_seen_atINTEGERNoCurrent Unix time in milliseconds—Most recent activity time, in Unix milliseconds.
ipTEXTYes——IP address.
user_agentTEXTYes——User-Agent.
countryTEXTYes——Country or region code.
two_factor_verifiedINTEGERNo0—Whether two-factor authentication has been completed in the current flow. 1 means verified.

two_factor_setup_session

Stores temporary secrets and recovery codes while setting up or replacing two-factor authentication.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idINTEGERNo—FK → saas_user.id (cascade delete)User ID.
saas_session_idTEXTNo—FK → saas_session.id (cascade delete)Sign-in session ID.
purposeTEXTNo——Purpose of this temporary session.
encrypted_totp_keyBLOBNo——TOTP secret stored encrypted during setup.
recovery_codesJSONNo——Array of recovery code hashes.
encrypted_recovery_codesBLOBNo——Recovery codes stored encrypted during setup.
attempt_countINTEGERNo0—Number of verification attempts made.
claimed_atINTEGERNo0—Time processing rights to this temporary record were claimed. 0 means not yet processed.
consumed_atINTEGERNo0—Time this temporary record was consumed. 0 means not yet used.
expires_atINTEGERNo——Expiration time, in Unix milliseconds.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.

email_verification_session

Stores verification codes and expiration times for the email verification flow.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idINTEGERNo——User ID.
emailTEXTNo——Email address.
codeTEXTNo——Verification code or authorization code.
typeTEXTNo——Record type.
attempt_countINTEGERNo0—Number of verification attempts made.
expires_atINTEGERNo——Expiration time, in Unix milliseconds.

password_reset_session

Stores verification codes, verification status, and expiration times for the password reset flow.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idINTEGERNo——User ID.
emailTEXTNo——Email address.
codeTEXTNo——Verification code or authorization code.
typeTEXTYes——Record type.
attempt_countINTEGERNo0—Number of verification attempts made.
expires_atINTEGERNo——Expiration time, in Unix milliseconds.
email_verifiedINTEGERNo0—Whether the email address has been verified. 1 means verified.
two_factor_verifiedINTEGERNo0—Whether two-factor authentication has been completed in the current flow. 1 means verified.

oauth_auth_session

Stores the temporary state of an OAuth 2.0 authorization request before the user approves it.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idINTEGERYes——User ID.
client_idTEXTNo——OAuth 2.0 client ID.
redirect_uriTEXTNo——Redirect URI used for this authorization request.
response_typeTEXTNo——OAuth 2.0 response type.
scopeTEXTYes——Scope string for this authorization request.
stateTEXTYes——OAuth 2.0 state, used to correlate authorization requests and prevent CSRF.
code_challengeTEXTYes——PKCE code challenge.
code_challenge_methodTEXTYes——PKCE code challenge method.
approved_atINTEGERYesNULL—Time the user approved authorization.
upgrade_detailsJSONYesNULL—Upgrade suggestion data used during authorization.
expires_atINTEGERNo——Expiration time, in Unix milliseconds.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.

oauth_client

Stores OAuth 2.0 clients, redirect URIs, grant types, and scopes.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
nameTEXTNo——Name.
secretTEXTYes——Hash of the OAuth 2.0 client secret. May be empty for public clients.
owner_user_idINTEGERYesNULL—User ID of the OAuth 2.0 client's owner.
redirect_urisJSONNo'[]'—Array of redirect URIs allowed for the client.
allowed_grantsJSONNo'[]'—Array of grant types allowed for the client.
scopesJSONNo'[]'—Array of scopes.
logo_uriTEXTYes——Client logo URL.
homepage_uriTEXTYes——Client homepage URL.
descriptionTEXTYes——Description text.
privacy_policy_uriTEXTYes——Privacy policy URL.
terms_of_service_uriTEXTYes——Terms of service URL.
disabled_atINTEGERNo0—Disable time. 0 means not disabled.
deleted_atINTEGERNo0—Soft deletion time. 0 means not deleted.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

oauth_auth_code

Stores OAuth 2.0 authorization codes and PKCE information.

FieldTypeNullableDefaultKeyDescription
codeTEXTNo—PKVerification code or authorization code.
redirect_uriTEXTYes——Redirect URI used for this authorization request.
code_challengeTEXTYes——PKCE code challenge.
code_challenge_methodTEXTYes'plain'—PKCE code challenge method.
expires_atINTEGERNo——Expiration time, in Unix milliseconds.
user_idINTEGERYesNULL—User ID.
client_idTEXTNo——OAuth 2.0 client ID.
scopesJSONNo'[]'—Array of scopes.
revoked_atINTEGERNo0—Revocation time. 0 means not revoked.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

oauth_token

Stores OAuth 2.0 access tokens and refresh tokens.

FieldTypeNullableDefaultKeyDescription
access_tokenTEXTNo—PKAccess token, also the table's primary key.
access_token_expires_atINTEGERNo——Access token expiration time, in Unix milliseconds.
refresh_tokenTEXTYes——Refresh token.
refresh_token_expires_atINTEGERYesNULL—Refresh token expiration time, in Unix milliseconds.
client_idTEXTNo——OAuth 2.0 client ID.
user_idINTEGERYesNULL—User ID.
oauth_codeTEXTYesNULL—Authorization code used to issue this token.
scopesJSONNo'[]'—Array of scopes.
revoked_atINTEGERNo0—Revocation time. 0 means not revoked.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

user_role_capability

Stores the static capabilities assigned to a subject by expanding a role grant.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
subject_typeTEXTNo——Subject type.
subject_idTEXTNo——Subject ID.
user_idINTEGERYes——User ID.
event_idTEXTYes——ID of the Reaction Event that granted this role capability.
command_idTEXTYes——ID of the Reaction Command that granted this role capability.
source_typeTEXTNo——Type of the role grant source.
source_keyTEXTNo——Source key for the role or entitlement.
role_keyTEXTNo——Role key from config/roles.ts.
capability_keyTEXTNo——Capability key from config/capability.ts.
starts_atINTEGERYesNULL—Effective start time, in Unix milliseconds.
ends_atINTEGERYesNULL—End time, in Unix milliseconds.
metadataJSONYes——Application metadata.
deleted_atINTEGERNo0—Soft deletion time. 0 means not deleted.
disabled_atINTEGERNo0—Disable time. 0 means not disabled.
disabled_reasonTEXTYes——Reason for disabling.
disabled_expires_atINTEGERNo0—End time of a temporary suspension. 0 means no end time is set.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

user_entitlement_capability

Stores the boolean or quota capabilities assigned to a subject by expanding an entitlement grant.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
subject_typeTEXTNo——Subject type.
subject_idTEXTNo——Subject ID.
user_idINTEGERYes——User ID.
event_idTEXTYes——ID of the Reaction Event that granted this entitlement capability.
command_idTEXTYes——ID of the Reaction Command that granted this entitlement capability.
source_typeTEXTNo——Type of the entitlement grant source.
source_keyTEXTNo——Source key for the role or entitlement.
source_quantityINTEGERNo1—Quantity granted by the source.
source_unit_limitINTEGERYesNULL—Quota provided by each source unit.
entitlement_keyTEXTNo——Entitlement key from config/entitlements.ts.
capability_keyTEXTNo——Capability key from config/capability.ts.
capability_typeTEXTNo——Capability type.
priorityINTEGERNo0—Priority. Higher values indicate higher priority.
rolloverINTEGERNo0—Whether unused quota rolls over at the end of the cycle. 1 means rollover is enabled.
quota_limitINTEGERNo0—Quota limit.
quota_totalINTEGERNo0—Total quota currently available.
quota_usedINTEGERNo0—Quota currently used.
quota_used_reset_modeTEXTNo'clear'—How used quota is handled when the reset cycle ends.
starts_atINTEGERYesNULL—Effective start time, in Unix milliseconds.
ends_atINTEGERYesNULL—End time, in Unix milliseconds.
reset_alignmentTEXTYesNULL—Quota cycle alignment.
reset_intervalTEXTYesNULL—Quota reset interval unit.
reset_interval_countINTEGERNo0—Number of units in each quota cycle.
anchor_atINTEGERNo——Quota cycle anchor time, in Unix milliseconds.
reset_period_countINTEGERYes0—Number of completed quota cycles.
anchor_reset_atINTEGERYes——Reset time for the current cycle, calculated from the anchor.
metadataJSONYes——Application metadata.
deleted_atINTEGERNo0—Soft deletion time. 0 means not deleted.
disabled_atINTEGERNo0—Disable time. 0 means not disabled.
disabled_reasonTEXTYes——Reason for disabling.
disabled_expires_atINTEGERNo0—End time of a temporary suspension. 0 means no end time is set.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.
updated_atINTEGERNoCurrent Unix time in milliseconds—Last update time, in Unix milliseconds.

capability_quota_event

Stores quota capability additions, deductions, resets, and rollovers.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
subject_typeTEXTNo——Subject type.
subject_idTEXTNo——Subject ID.
user_idINTEGERYes——User ID.
source_typeTEXTNo——Type of the source that generated the quota record.
source_keyTEXTNo——Source key for the role or entitlement.
entitlement_keyTEXTNo——Entitlement key from config/entitlements.ts.
capability_keyTEXTNo——Capability key from config/capability.ts.
event_typeTEXTNo——Quota change type, such as grant, usage, or reset.
deltaINTEGERNo——Amount of this quota change. Positive values add quota, and negative values deduct it.
reasonTEXTYes——Reason for this quota change.
metadataTEXTYes——Application metadata.
created_atINTEGERNoCurrent Unix time in milliseconds—Creation time, in Unix milliseconds.

event_execution

Stores Reaction Event input snapshots, idempotency keys, and execution leases.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idINTEGERYes——User ID.
event_typeTEXTNo——Reaction Event type.
event_versionINTEGERNo——Event definition version.
idempotency_keyTEXTNo——Event idempotency key.
continue_on_failureINTEGERNo——Whether to continue with subsequent Commands after a Command reports a business failure.
payloadTEXTNo——Serialized input data.
created_atINTEGERNo——Creation time, in Unix milliseconds.
lease_tokenTEXTYes——Token for the current execution lease.
lease_expires_atINTEGERYes——Expiration time of the current execution lease.

command_execution

Stores Commands generated by an Event, their execution order, retry counts, and results.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
event_execution_idTEXTNo—FK → event_execution.id (cascade delete when the Event is deleted)Parent Event execution record ID.
user_idINTEGERYes——User ID.
command_keyTEXTNo——Command step name, unique within the same Event.
command_typeTEXTNo——Command type.
command_versionINTEGERNo——Command definition version.
modeTEXTNo——Command execution mode: sync or async.
max_attemptsINTEGERNo——Maximum number of automatic executions allowed.
sequenceINTEGERNo——Command execution order within the Event.
payloadTEXTNo——Serialized input data.
statusTEXTNo——Current status.
attempt_countINTEGERNo0—Number of executions so far.
resultTEXTYes——Serialized Command return value.
last_errorTEXTYes——Error message from the most recent processing failure.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.
completed_atINTEGERYes——Completion time, in Unix milliseconds.

webhook_events

Stores raw payment provider webhook requests, processing status, and failure information.

FieldTypeNullableDefaultKeyDescription
idINTEGERNo—PKRecord primary key.
providerTEXTNo——Payment provider that sent the webhook.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
event_idTEXTNo——Webhook event ID supplied by the payment provider.
event_typeTEXTNo——Webhook event type supplied by the payment provider.
user_idTEXTYes——User ID.
occurred_atINTEGERYes——Event occurrence time recorded by the payment provider, in Unix milliseconds.
raw_bodyTEXTNo——Raw webhook request body, used for signature verification and replay.
statusTEXTNo'processing'—Current status.
claim_tokenTEXTYes——Token used for the webhook processing lease.
last_errorTEXTYes——Error message from the most recent processing failure.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

payment_customers

Maps local users to payment provider Customers.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
user_idTEXTNo——User ID.
providerTEXTNo——Payment provider the Customer belongs to.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
provider_customer_idTEXTNo——Customer ID in the payment provider.
is_primaryINTEGERNo0—Whether this is the user's primary Customer for this payment connection. 1 means yes.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

checkout_sessions

Stores local Checkout Sessions and the status returned by the payment provider.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
providerTEXTNo——Payment provider the Checkout belongs to.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
provider_checkout_typeTEXTNo——Checkout type in the payment provider.
provider_checkout_idTEXTYes——Checkout ID in the payment provider.
customer_idTEXTNo—FK → payment_customers.idpayment_customers record ID.
modeTEXTNo——Checkout mode: one-time payment or subscription.
statusTEXTNo——Current status.
provider_statusTEXTYes——Original status returned by the payment provider.
payment_statusTEXTNo'pending'—Payment status.
provider_payment_statusTEXTYes——Original payment status returned by the payment provider.
has_invoice_creationINTEGERNo0—Whether the payment provider is requested to create an invoice. 1 means yes.
checkout_requestJSONYes——Snapshot of the request used to create the Checkout.
contextJSONYes——Application context saved when the Checkout was created.
metadataJSONYes——Application metadata.
currencyTEXTYes——Currency code.
amount_total_minorINTEGERYes——Total Checkout amount, in the currency's smallest unit.
provider_dataJSONYes——Original data returned by the payment provider.
last_errorTEXTYes——Error message from the most recent processing failure.
provider_updated_atINTEGERYes——Last update time in the payment provider, in Unix milliseconds.
expires_atINTEGERYes——Expiration time, in Unix milliseconds.
completed_atINTEGERYes——Completion time, in Unix milliseconds.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

purchase_items

Stores one-time purchase items in a Checkout Session.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
checkout_session_idTEXTNo—FK → checkout_sessions.id (cascade delete)checkout_sessions record ID.
provider_line_item_idTEXTYes——Line item ID in the payment provider.
provider_product_idTEXTYes——Product ID in the payment provider.
provider_price_idTEXTYes——Price ID in the payment provider.
provider_variant_idTEXTYes——Variant ID in the payment provider.
descriptionTEXTYes——Description text.
quantityINTEGERYes——Quantity.
metadataJSONYes——Application metadata.
provider_dataJSONYes——Original data returned by the payment provider.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

subscriptions

Stores payment provider subscriptions and their billing periods, pauses, cancellations, and amounts.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
customer_idTEXTNo——payment_customers record ID.
checkout_session_idTEXTYes——checkout_sessions record ID.
providerTEXTNo——Payment provider the subscription belongs to.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
provider_subscription_idTEXTNo——Subscription ID in the payment provider.
statusTEXTNo——Current status.
provider_statusTEXTYes——Original status returned by the payment provider.
collection_modeTEXTNo'unknown'—Subscription payment collection method.
collection_pausedINTEGERNo0—Whether payment collection is paused for the subscription. 1 means paused.
collection_pause_resumes_atINTEGERYes——Scheduled time to resume payment collection.
collection_pause_detailsJSONYes——Payment collection pause details returned by the payment provider.
started_atINTEGERYes——Subscription start time, in Unix milliseconds.
trial_startINTEGERYes——Trial start time, in Unix milliseconds.
trial_endINTEGERYes——Trial end time, in Unix milliseconds.
current_period_startINTEGERYes——Start of the current billing period, in Unix milliseconds.
current_period_endINTEGERYes——End of the current billing period, in Unix milliseconds.
cancel_at_period_endINTEGERNo0—Whether to cancel at the end of the current billing period. 1 means yes.
cancel_atINTEGERYes——Scheduled cancellation time, in Unix milliseconds.
canceled_atINTEGERYes——Cancellation time, in Unix milliseconds.
paused_atINTEGERYes——Pause time, in Unix milliseconds.
ends_atINTEGERYes——Expected subscription end time supplied by the payment provider, in Unix milliseconds.
ended_atINTEGERYes——Subscription end time, in Unix milliseconds.
scheduled_changeJSONYes——Scheduled subscription change returned by the payment provider.
scheduled_change_atINTEGERYes——Time the scheduled change takes effect.
next_billed_atINTEGERYes——Next charge time, in Unix milliseconds.
next_amount_minorINTEGERYes——Amount due for the next period, in the currency's smallest unit.
next_currencyTEXTYes——Payment currency for the next period.
metadataJSONYes——Application metadata.
provider_dataJSONYes——Original data returned by the payment provider.
provider_updated_atINTEGERYes——Last update time in the payment provider, in Unix milliseconds.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

subscription_items

Stores subscription products, Prices, quantities, and billing periods.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
subscription_idTEXTNo—FK → subscriptions.id (cascade delete)Subscription ID.
provider_subscription_item_idTEXTYes——Subscription Item ID in the payment provider.
provider_product_idTEXTYes——Product ID in the payment provider.
provider_price_idTEXTYes——Price ID in the payment provider.
descriptionTEXTYes——Description text.
quantityINTEGERYes——Quantity.
unit_amount_minorINTEGERYes——Unit price, in the currency's smallest unit.
currencyTEXTYes——Currency code.
pricing_modelTEXTNo'unknown'—Pricing model.
billing_intervalTEXTYes——Billing interval unit.
billing_interval_countINTEGERYes——Number of units in a billing period.
current_period_startINTEGERYes——Start of the current billing period, in Unix milliseconds.
current_period_endINTEGERYes——End of the current billing period, in Unix milliseconds.
metadataJSONYes——Application metadata.
provider_dataJSONYes——Original data returned by the payment provider.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

transactions

Stores payment transactions, invoice amounts, payer details, and invoice information.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
public_reference_idTEXTNo——Transaction reference number that can be shown to users.
providerTEXTNo——Payment provider the transaction belongs to.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
source_typeTEXTNo——Type of the original transaction object in the payment provider.
provider_source_idTEXTNo——ID of the original transaction object in the payment provider.
customer_idTEXTYes——payment_customers record ID.
checkout_session_idTEXTYes——checkout_sessions record ID.
provider_customer_idTEXTYes——Customer ID in the payment provider.
provider_subscription_idTEXTYes——Subscription ID in the payment provider.
kindTEXTNo——Transaction type, such as a one-time payment, initial subscription payment, or subscription renewal.
statusTEXTNo——Current status.
provider_statusTEXTYes——Original status returned by the payment provider.
collection_modeTEXTNo'unknown'—Subscription payment collection method.
subtotal_minorINTEGERYes——Subtotal before discounts and taxes, in the currency's smallest unit.
discount_minorINTEGERYes——Discount amount, in the currency's smallest unit.
tax_minorINTEGERYes——Tax amount, in the currency's smallest unit.
total_minorINTEGERNo——Total amount, in the currency's smallest unit.
amount_due_minorINTEGERYes——Amount due, in the currency's smallest unit.
amount_paid_minorINTEGERYes——Amount paid, in the currency's smallest unit.
amount_remaining_minorINTEGERYes——Unpaid amount, in the currency's smallest unit.
currencyTEXTNo——Currency code.
billing_reasonTEXTYes——Billing reason that generated this transaction.
payer_emailTEXTYes——Payer email address.
payer_nameTEXTYes——Payer name.
billing_addressJSONYes——Billing address.
tax_identifiersJSONYes——Array of tax identifiers.
invoice_numberTEXTYes——Invoice number.
document_urlTEXTYes——Invoice document URL supplied by the payment provider.
document_pdf_urlTEXTYes——PDF invoice URL supplied by the payment provider.
failure_codeTEXTYes——Failure code returned by the payment provider.
failure_reasonTEXTYes——Reason for the processing failure.
metadataJSONYes——Application metadata.
provider_dataJSONYes——Original data returned by the payment provider.
provider_updated_atINTEGERYes——Last update time in the payment provider, in Unix milliseconds.
issued_atINTEGERYes——Invoice or transaction issue time, in Unix milliseconds.
due_atINTEGERYes——Payment due time, in Unix milliseconds.
paid_atINTEGERYes——Time payment for the transaction was completed, in Unix milliseconds.
occurred_atINTEGERNo——Time the transaction actually occurred, in Unix milliseconds.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

transaction_items

Stores transaction products, Prices, billing periods, and amount breakdowns.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
transaction_idTEXTNo—FK → transactions.id (cascade delete)Transaction ID.
provider_line_item_idTEXTYes——Line item ID in the payment provider.
provider_product_idTEXTYes——Product ID in the payment provider.
provider_price_idTEXTYes——Price ID in the payment provider.
provider_variant_idTEXTYes——Variant ID in the payment provider.
provider_subscription_item_idTEXTYes——Subscription Item ID in the payment provider.
descriptionTEXTYes——Description text.
billing_typeTEXTNo'unknown'—Billing type of the transaction line item.
is_prorationINTEGERNo0—Whether this line item is a proration adjustment. 1 means yes.
billing_intervalTEXTYes——Billing interval unit.
billing_interval_countINTEGERYes——Number of units in a billing period.
period_startINTEGERYes——Start of the billing period for this line item, in Unix milliseconds.
period_endINTEGERYes——End of the billing period for this line item, in Unix milliseconds.
quantityINTEGERYes——Quantity.
unit_amount_minorINTEGERYes——Unit price, in the currency's smallest unit.
unit_amount_decimalTEXTYes——High-precision unit price string returned by the payment provider.
subtotal_minorINTEGERYes——Subtotal before discounts and taxes, in the currency's smallest unit.
discount_minorINTEGERYes——Discount amount, in the currency's smallest unit.
tax_minorINTEGERYes——Tax amount, in the currency's smallest unit.
total_minorINTEGERNo——Total amount, in the currency's smallest unit.
currencyTEXTNo——Currency code.
metadataJSONYes——Application metadata.
provider_dataJSONYes——Original data returned by the payment provider.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.

refunds

Stores transaction refunds and the refund status returned by the payment provider.

FieldTypeNullableDefaultKeyDescription
idTEXTNo—PKRecord primary key.
transaction_idTEXTNo—FK → transactions.id (prevents deletion of transactions that still have refunds)Transaction ID.
providerTEXTNo——Payment provider the refund belongs to.
connection_idTEXTNo——Payment connection ID from config/payment.ts.
provider_refund_typeTEXTNo——Refund type in the payment provider.
provider_refund_idTEXTNo——Refund ID in the payment provider.
provider_parent_typeTEXTYes——Refund parent object type in the payment provider.
provider_parent_idTEXTYes——Refund parent object ID in the payment provider.
statusTEXTNo——Current status.
provider_statusTEXTYes——Original status returned by the payment provider.
amount_minorINTEGERNo——Amount, in the currency's smallest unit.
tax_amount_minorINTEGERYes——Tax amount included in the refund, in the currency's smallest unit.
currencyTEXTNo——Currency code.
reasonTEXTYes——Refund reason supplied by the payment provider.
failure_reasonTEXTYes——Reason for the processing failure.
metadataJSONYes——Application metadata.
provider_dataJSONYes——Original data returned by the payment provider.
provider_updated_atINTEGERNo——Last update time in the payment provider, in Unix milliseconds.
occurred_atINTEGERNo——Time the refund actually occurred, in Unix milliseconds.
created_atINTEGERNo——Creation time, in Unix milliseconds.
updated_atINTEGERNo——Last update time, in Unix milliseconds.