GetPaidX docs
End-user reference manual
This is the plain-English product manual for GetPaidX. Use it when you want to understand how a feature works, what each setting means, and how public, buyer, creator, and collaborator flows connect.
Search docs
Keyword search across docs titles, summaries, headings, and curated keywords.
Start as a creatorSet up your profile, featured workspace, payouts, and first priced offer.Understand buyingSee how posts, purchases, entitlements, and subscriptions fit together.Use places and QRLearn check-in, place pages, QR entry, live chat, and venue-linked posting.Work with workspacesUnderstand launch, access, artifacts, publishing, and automation controls.
Getting Started
Orientation, sign-in, and onboarding paths for new users.
- GetPaidX OverviewThe plain-English orientation for what the app is, how the main surfaces fit together, and where new users should start.
- Sign In and OnboardingHow sign-in works, when it is required, and how the GitHub and Product Hunt onboarding flows fit into account setup.
- Feed, Discovery, and FollowingHow the feed works, what the main filters mean, and how Everyone, Following, views, hashtags, and timing filters shape discovery.
- Feed Map, Places, and Location FiltersHow the Map and Places views behave, what Nearby and city filters really do, and what users should expect when location data is missing or mixed.
Profiles and Presence
Public identity, featured profile workspace, and public routing.
- Profile and Featured WorkspaceHow profile basics, the featured profile workspace, and the public workspace routes define your persistent public presence.
- Membership Manager and Member TagsHow creators organize members on the profile page, what Join membership and Leave membership do, and how member tags support later audience selection.
- Mention Approval and Profile MentionsHow approved and pending mentions appear on profile pages, when creators can approve or reject them, and what mention approval changes for public visibility.
- Native Profile Workspace Chat and Owner MessagesHow the built-in profile workspace chat behaves for profile owners and visitors, what the loading and waiting states mean, and what users should expect from ongoing conversations.
- Profile Workspace Activation, Place, Schedule, and HeartbeatHow creators activate a featured profile workspace onto a place, what future date and time mean, and when the app creates an automatic heartbeat rule for ongoing presence.
- Profile Workspace Check-In States and Active Room TimingHow profile-workspace check-in behaves on place pages, what already-checked-in means, and how long the app treats the room as active after a successful check-in.
- Profile Workspace Bootstrap and Featured Post ReuseHow the app creates a profile workspace for a user who does not have one yet, and how it reuses an existing featured profile-workspace post instead of creating duplicates.
- Profile Workspace Default Template and First-Run ContentHow a newly provisioned profile workspace gets its default runtime shape, what starter content users may inherit on first run, and how that differs from later manual template changes.
- Profile Workspace Title, Body, and Bio FallbacksHow the app chooses a first title and body for a profile workspace when a user has partial or missing profile details, and how professional title, about text, bio, and email fallback rules affect that first draft.
Posts and Offers
Posts, replies, mentions, pricing, purchases, and sharing.
- Create Posts and Manage VisibilityHow posts work, what the main fields mean, and how replies, mentions, audience tags, and sharing affect the buyer or viewer experience.
- Audience Tags, Memberships, and VisibilityHow audience tags work in the post UI, how they relate to followers and memberships, and what viewers should expect when a post is restricted.
- Hashtags, Mentions, and Membership TagsHow hashtags affect discovery, how mentions behave in posts, and how membership tags are used to organize followers into audience groups.
- Post Pricing and PurchasesWhat the pricing controls mean, how one-time and monthly pricing differ, and what buyers should expect after checkout.
- Post Purchase States and Access CTAsHow a post page changes between author view, locked buyer view, purchased viewer state, and monetization-setup state, including the main CTAs users actually see.
- Post Management, Editing, Pricing, and Co-SellersHow authors edit posts after publishing, what pricing-locked means inside edit mode, and how co-seller setup appears on managed posts.
- Reply as New Post and Conversation BranchingHow reply creation works when replies become full posts, how the parent-post context is preserved, and how users should think about branching a thread into separate offers or updates.
Places and Check-Ins
Place discovery, QR entry, live presence, and place chat.
- Places, QR Entry, and Place ChatHow place pages work, what QR entry does, and how active presence affects check-ins and access to place chat.
- Place QR Onboarding and Auto Check-In StatesHow QR entry moves between onboarding, browse-only, auto check-in success, already-checked-in, and error states on place pages.
- Place Chat and People at This PlaceHow place chat unlocks, what anonymous and checked-in viewers can see, how the At location only filter behaves, and what the People at this place list represents.
- Place Posts and Tentative Check-InsHow the place page groups upcoming and past posts, what Tentative check-ins means, and how active-check-in metadata connects to venue activity.
- Place QR Share and Referral LinksHow the place QR share card works, what Copy link, Download PNG, and Print are for, and how referral-carrying place links fit into in-store onboarding.
- Place-Linked Post Creation and Prefilled Venue FlowHow Create a post from a place page pre-fills venue context, how replying vs venue-first creation differ, and what users should expect from the Create a post or event screen.
- Place Post Entry and Active Check-In CountsHow the place page invites users to create a post, what the Active check-ins count means, and how that card reflects current venue activity instead of all historical traffic.
- Place Details Cards, Website, Address, and Visit SiteHow the place page details card works, what metadata items like Website and Address mean, and how the Visit site link differs from GetPaidX-native activity around the venue.
- Place QR Short Links and Attribution CaptureHow `/p/{googlePlaceId}` short links resolve into the real place page, which tracking parameters are preserved, and what the QR landing capture is for from an end-user perspective.
Monetization
Plans, payouts, referrals, co-sellers, and subscription state.
- Subscription, Payouts, and ReferralsHow the platform plan, Stripe payouts, creator dashboard, referrals, co-sellers, and post subscriptions fit together.
- Payouts and Stripe ConnectWhat the payout settings mean, how Stripe onboarding behaves, and how seller and transfer payout readiness affect monetization.
- Creator Dashboard and Sales MetricsHow to read the creator dashboard, which cards reflect revenue or subscriber health, and where to act when monetization needs attention.
- Creator Dashboard Subscriber Health and Payout QueuesHow to read the creator dashboard’s subscriber-health cards, recent subscriber rows, pending payout surfaces, failed transfer surfaces, and account-status actions.
- Co-Seller Payout Transfer TroubleshootingHow to interpret pending and failed co-seller transfer states, when Retry transfer is appropriate, and what creators should fix before retrying.
- Creator Dashboard Buyer Purchase HistoryHow to read the Your recent purchases section on the creator dashboard and what hosted-by, on-demand, and purchase-status rows tell the user.
- Top Performing Posts, Gross, Net, and FeesHow to read the Top performing posts table, what gross vs net means, and how creators should interpret sales counts and fee impact across priced posts.
- Creator Dashboard Reply Moderation and Mentions Auto-ApproveHow the creator dashboard moderation toggles affect reply visibility and mention approval, and when creators should leave those controls on or off.
- Reply Review States and Moderation OutcomesHow reply cards move through Awaiting review, Accepted, and Needs revision, and what moderators and reply authors can do at each stage.
- Referrals, Co-Sellers, and Claiming InvitesHow referral locks work, what invite claiming changes for a creator, and how co-seller earnings and transfers appear in settings.
- Post Subscriptions and Buyer Renewal StateHow recurring and one-time post access appears from the buyer side, what renewal status means, and what happens when cancellation is scheduled.
- Checkout Success, Cancellation, and Access StateWhat buyers should expect after a successful checkout, what the cancel page means, and how access moves from purchase into post access or subscription management.
Workspaces and Artifacts
Interactive workspaces, artifact sites, permissions, and automations.
- Workspaces, Artifacts, and AutomationsHow the post workspace works, how it differs from artifacts, and what the main automation and access controls mean for end users.
- Workspace Runtime, Preview, and PublishingHow runtime defaults, live preview startup, static preview files, and published artifact site settings map to the Config tab.
- Workspace Automation ControlsThe end-user guide to schedule setup, webhook triggers, Telegram and WhatsApp controls, and what each workspace automation setting changes.
- Workspace Billing, Access, and CollaborationWhat author pays vs collaborator pays means, how purchase requirements work, and how edit collaborators are granted or restricted.
- Workspace Rules and Trigger StatesHow the Rules tab works, what enabled or disabled rules mean, and how schedules, webhook rules, and system triggers are surfaced to end users.
- Telegram and WhatsApp Channel SetupHow the profile-workspace Telegram and WhatsApp controls work, when the workspace is ready for each channel, and what the main channel states mean.
- Signed WEBHOOK_EVENT Automation TriggersHow WEBHOOK_EVENT rules are configured, what token and secret fields mean, how signed inbound payloads trigger runs, and how users should troubleshoot rejected webhook events.
- Workspace System-Trigger StatusHow the System triggers status cards work, what Telegram and WhatsApp status fields mean, and how those channel states relate to webhook-style automation runs.
- Workspace Preview Embed vs New-Tab FallbackHow the app chooses between embedded workspace preview and opening a separate preview tab, and what users should infer when the workspace starts but the inline embed is unavailable.
- Workspace Resumed Sessions and Resume CommandsHow the app resumes an existing interactive workspace session instead of always starting a new one, and what resumed session messages and resume commands mean for end users.
- Workspace Close Session vs Close AllHow closing one workspace session differs from closing all active sessions, where each action appears, and what users should expect from single-session cleanup compared with global cleanup.
- Workspace Close-All Cleanup and Partial FailuresHow the Close all active workspaces action behaves, what full vs partial cleanup results mean, and how retry-after-cleanup works when a launch was blocked by concurrency limits.
- Workspace Start Errors, Capacity, and CreditsHow workspace launch failures are presented to users, what busy-controller and concurrency states mean, and when AI-credit balance blocks a launch.
- Workspace Defaults, Env Vars, and Runtime CommandsHow the Defaults tab controls live preview startup, static preview and published-site paths, JSON env/secrets, and who can open or edit a workspace.
- Workspace Templates, Pools, and Replace BehaviorHow the template gallery works, what details like publish target and entry file mean, and why applying a template can replace files or restart the workspace on a different pool.
- Workspace Template Archive ZIP and Export FidelityHow template ZIP archives are produced, what they preserve, and why advanced users should not assume the archive contains every ignored or controller-only file from a running workspace.
- Workspace Upload Targets and ZIP Merge BehaviorHow the Upload tab works in edit mode, what Workspace project vs Static preview site mean, how target paths are resolved, and what ZIP merge actually does.
- Workspace Terminal, Helix, and Codex Tool AccessHow the live preview and embedded workspace tools differ, what read-only viewer mode means for Terminal, Helix, and Codex, and how sessions and Codex shortcuts fit into edit-mode work.
- Workspace Usage, Credits, and Rolling WindowsHow the workspace usage tab reports Codex request counts and token totals, how those numbers relate to your AI credit balance, and what rolling windows tell you about recent activity.
- Workspace Manual Runs and Run HistoryHow one-off manual runs differ from reusable rules, what queued or failed runs mean, and how to read the Runs tab when automation results look stuck or incomplete.
- Workspace History, Snapshots, and RollbackHow the History tab works, what Save snapshot creates, what Restore changes, and how users should think about revisions, rollback, and persistence.
- Reply Workspace Clone Eligibility and LimitsHow reply authors can clone a parent workspace into a reply, when that option appears, and which limits prevent cloning even if the parent post already has a workspace.
- Workspace Attachments, Published Site, and Share LinksHow the Artifact and Workspace tabs relate, what published-site visibility and expiry mean, and how authors manage share links for artifact sites.
- Artifact Site Expiry, Revoke, and Share LifecycleHow authors manage an existing artifact-site share after it is published, what Revoke link and Expire in 24h do, and how users should think about a share link over time.
- Artifact Site Access Failures: Sign-In, Purchase, Revoked, and ExpiredHow artifact-site open failures differ between missing sign-in, missing entitlement, revoked links, and expired links, and what users should expect from each path.
- Artifact Site Anonymous Access and Public EligibilityHow the app decides when an artifact site can open without sign-in, why some public-looking links still redirect to login, and how purchase rules change anonymous access.
- Artifact Site Pub-Token and Signed Viewer HandoffHow signed-in viewers are handed off from the main app to the pub host, why a short-lived token is added for that redirect, and what users should understand about that access bridge.
- Artifact Site Cookie Bridge and Pub-Host Session PersistenceHow the pub host turns a short-lived `gpx_token` redirect parameter into a `gpx_pub_token` cookie, and what that temporary cookie means for signed viewers who keep browsing the published site.
- Artifact Attachment Replacement and Commit FlowHow single-file artifact attachment replacement works for authors, what upload URL and commit mean in practical terms, and how this differs from publishing a multi-file artifact site.
- Artifact Site Publish Request and Canonical Share UpdatesHow the Publish site action works for workspace-backed sites, what publish success and failure states mean, and how repeated publishes affect the canonical share URL.
API and Account Controls
PATs, webhooks, notifications, usage, and custom domains.
- API Tokens, Webhooks, and Account ControlsThe browser-level guide to PATs, webhooks, notifications, usage, AI credits, and custom domains.
- Notifications, Usage, and AI CreditsHow notification preferences, AI credit balance, usage metrics, and active workspace session controls work from the account settings side.
- Custom Domains and Branded HostsHow branded hosts are requested, what the DNS and Bind steps mean, and what changes once your domain is live.
- Custom Domain DNS and Bind TroubleshootingHow to interpret DNS pending, DNS verified, disabled, and bound states, and what to check when branded-host setup does not progress.
- API Webhook Delivery Status and TroubleshootingHow to read the webhook rows in account settings, what last error means, how retry timing works from a user standpoint, and how to troubleshoot PAT and webhook setup problems.