Placement Guide
Short description
Before you begin building with our platform, it’s important to properly configure your workspace. This ensures smooth collaboration, secure access, and a clear structure for managing your products and data.
Step 1: Create Your Workspace
A workspace is where all your projects, products, and integrations live.
Log in to your account.
Navigate to Workspaces → Create New Workspace.
Enter a workspace name (e.g., MyCompany or FinanceTeam).
Choose your default region for data storage.
Workspaces can contain multiple projects. You can set up separate workspaces for production, sandbox/testing, or different teams.
Step 2: Invite Team Members
Collaborate with your team by assigning roles and permissions.
Admin → Full control over workspace settings.
Developer → Access to API keys, integrations, and testing environments.
Finance Manager → Access to payouts, invoices, and reports.
Viewer → Read-only permissions.
Example Table
Role | Permissions | Use Case |
|---|---|---|
Admin | Full access to all settings | Founders, Team leads |
Developer | API, integrations, sandbox access | Engineering team |
Finance Manager | Reports, payouts, subscriptions | Finance & accounting |
Viewer | Read-only, no edits | Stakeholders, Auditors |
Step 3: Configure Your Environment
When you create a new workspace, two environments are automatically available:
Sandbox → Safe testing area for experiments.
Production → Live environment for real transactions.
Switching Environments (Code Example)
javascript
Always test in sandbox before moving changes into production.
Step 4: Generate API Keys
To connect your workspace with external apps or your own systems, you’ll need API keys.
Go to Workspace → API Keys.
Generate a sandbox key for testing.
Generate a production key for live use.
Step 5: Set Up Notifications
Keep your team updated with real-time alerts.
Email notifications → Payouts, subscription events.
Slack integration → Failed payments, fraud detection.
Webhooks → Custom automation for advanced workflows.
Workspace Ready!
Once your workspace is set up, you can start creating products, managing subscriptions, and integrating with your preferred tools.