Skip to main content

Developer Portal Guide

The fype Developer Portal is your mission control for managing payments orchestration. This guide covers how to use its features to build, test, and monitor your integration.

1. Environment Management

fype provides two entirely separate environments: Test and Live.
  • Use the Mode Toggle in the sidebar to switch between them.
  • Test Mode: For development and using the fype Simulator.
  • Live Mode: For production transactions with real payment providers.
  • Note: API Keys, Provider Connections, and Webhook Endpoints are environment-specific.

2. API Key Management

Located under Developers > API Keys.
  • Generate Key: Creates a unique fype_test_ or fype_live_ secret key.
  • Raw Key Visibility: The secret key is shown only once. Copy and store it in a secure vault or environment variable immediately.
  • Key Prefixing: Keys are prefixed with their environment and a short unique identifier (e.g., fype_test_abc123_...) to help you identify which key is being used in logs.
  • Revocation: If a key is leaked, click the Trash icon. The key will be invalidated instantly.

3. Webhook Orchestration

Located under Developers > Webhooks.
  • Endpoints: Add the URL of your backend listener. You can add up to 5 endpoints per environment.
  • Signing Secret: Each endpoint has a unique whsec_ secret. Use this to verify fype signatures in your code.
  • Delivery Logs: Click on an endpoint to see its history. You can view:
  • Attempt Number: Shows how many times fype tried to send the webhook.
  • Status Code: The HTTP response code returned by your server.
  • Response Body: The first 1KB of your server’s response (useful for debugging 500 errors).
  • Event Link: A direct link to the canonical payment event that triggered the webhook.
  • Trigger Test: Use this button to send a simulated payment.succeeded event to your URL without creating a real payment.

4. Payment Monitoring & Auditing

Located under the Payments tab.
  • Search & Filter: Find payments by fype ID, Reference ID, Customer Email, or Status.
  • Payment Lifecycle: Click any payment to see its “Event Timeline”:
  • payment.created: When the intent was registered.
  • payment.processing: When the customer opened the checkout.
  • payment.succeeded: When the gateway confirmed capture.
  • Metadata View: View the custom JSON metadata you sent during payment creation.
  • Provider Response: View the raw, redacted JSON response from the underlying gateway (e.g., Razorpay) for deep debugging.

5. Provider Connections

Located under Providers.
  • Manage your credentials for Razorpay.
  • View connection status and “Last Validated” timestamp.
  • Credential Rotation: To update your Razorpay secret, simply edit the connection and save. fype will use the new secret for all new checkout sessions.

6. Subscription & Catalog Management

Located under Catalog and Subscriptions.
  • Catalog Management: View and edit the nested hierarchy of your product lines (Product Families, Products, plans, prices, and entitlements). You can link feature gates (entitlements) directly to products from here.
  • Subscriptions Command Center: Track active subscriptions, start dates, and trial periods. You can execute administrative operations directly from the action drawer:
  • Pause/Resume: Defer or resume automatic recurring cycles.
  • Cancel: Cancel immediately or schedule cancellation for the end of the billing period.
  • Plan Upgrade/Downgrade: Switch the customer’s plan mid-cycle with real-time automated proration credit calculation.

7. Customer Directory & Invoices

Located under Customers and Invoices.
  • Customer Lookup: A centralized directory displaying all customer emails, total active subscriptions, status, and lifetime revenue.
  • Invoice Auditing: Review details of auto-generated cycle bills and proration adjustments. View detailed GST breakdowns (CGST, SGST, IGST) and line-item charges.

8. Usage Metering

Located under the Usage tab.
  • Consumption Logs: Real-time graphs showing usage events (e.g. API tokens, seats, data transfer).
  • Simulator Tool: Submit simulated usage events directly from the dashboard to test aggregation and proration before billing cycles close.

9. A/B Testing & Experiments

Located under Experiments.
  • Pricing & Paywall Tests: Design A/B pricing tests using the Experiment Builder wizard. Set variant allocations (e.g., 50/50 split) and assign targeting rules.
  • Bayesian Evaluation: Monitor live tests to see visitors, conversions, and MRR lift. Fype evaluates results using a Bayesian probability model, displaying the statistical Chance to Win for treatment variants.

10. SaaS Analytics & Cohort Retention

Located under the main Analytics overview dashboard.
  • SaaS Metric Cards: Real-time tracking of Monthly Recurring Revenue (MRR), Annual Recurring Revenue (ARR), Churn Rate, and Customer Lifetime Value (LTV).
  • MRR Decomposition Chart: Visualizes MRR movements over time, breaking down new revenue, expansion upgrades, contraction downgrades, and churn.
  • Cohort Retention Matrix: Displays user retention heatmaps by activation cohort to measure long-term retention trends.

11. Team & Account Settings

Located under Settings.
  • Merchant Profile: Update your business name (displayed on the checkout page) and contact email.
  • Security: Change your dashboard password or enable Multi-Factor Authentication (MFA).