Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.metrifox.com/llms.txt

Use this file to discover all available pages before exploring further.

Metrifox helps you focus on what matters most in your business while handling all your revenue end to end.
1

Create Your Account

Start by creating your Metrifox account. It is free to get started.When you sign up or log in, you always land in your Sandbox environment first. Sandbox is designed for testing and learning how Metrifox works before going live. In Sandbox, you can use the app without feature limitations, with one limit: you can only have 5 customers at once.After testing, you can prepare your live setup by creating and launching offerings, then promote to Production.Once you switch to your Production environment, you can begin processing live billing data and managing active customer subscriptions.Upon sign-up, you are automatically assigned the Free plan, which provides limited access to the application’s features and volumes. This plan remains active until you choose to upgrade to the Growth plan to remove these limits and access additional tools.
2

Model Your Pricing

The core of Metrifox is our product catalog, where you define what you sell and how you charge for it. You’ll model your offering using a few key building blocks:
  • Products: Represent a product family or business line (e.g., “AI Evaluative Conversation API,” “Enterprise Dashboard”).
  • Offerings: Define how a product is packaged and priced. This includes:
    • Plans: Fixed or variable recurring subscriptions (e.g., Pro Plan, Enterprise Plan).
    • Add-ons: One-time, fixed or variable recurring purchases that extend a plan (e.g., “Additional Support Tier”, Copilot AI agent).
    • Single purchases: One-time payments that can either be based on a fixed flat price, or dynamic price.
  • One-time Fees: Charges for specific actions (e.g., setup fees, cancellation fees).
  • Features: The monetizable functionality, value or resource in your application. Features can be limited by usage, outcomes, seats, or simple binary access. This is what you entitle a customer to when they purchase a plan. Example: “AI Tokens per month,” “Number of Seats”, “Access to Premium Analytics”.
👉 Next Step: Create your first product
3

Integrate the SDK

Once your pricing is modeled, integrate Metrifox into your application with our lightweight SDK. This is typically a one-time engineering task.How it works:
  1. Check Entitlements: Use the checkAccess method to query Metrifox in real-time and determine whether a customer is entitled to a specific feature. The method evaluates access based on the customer’s plan, active add-ons, usage limits, and available credit balance e.g. “Does this customer have access to document evaluator?”
  2. Send Events: Use the recordUsage method to log granular usage events to Metrifox in real time. This enables accurate metering, billing, and entitlement tracking across features and plans (e.g., “tokens_used: 5000”, “user_added: 1”).
The magic is that once this is done, you can change prices and packaging in the Metrifox dashboard without writing any new code.👉 Next Step: Choose your SDK and see installation guide
4

Configure Subscription Settings

The Subscription Settings menu is the central hub for defining how Metrifox handles billing cycles, payment collection, and lifecycle mutations like upgrades or cancellations. You can manage these configurations by navigating to Settings → Subscription.
  • Collection Mode for In-Advance Plans: For plans billed at the start of a cycle, you must define the “handshake” between payment and service activation. Choose between prepaid or postpaid.
    • Prepaid: The subscription is provisioned and activated only after a successful payment has been processed. The service remains inactive until the invoice is cleared.
    • Postpaid: The subscription is activated immediately, allowing the customer to use the service while an invoice is generated for later payment.
  • Skip Card Collection for In-Arrears Plans: This toggle defines whether a payment method is required at the point of checkout for plans billed in arrears.
    • When Enabled: Customers can initiate a subscription without a credit card on file. They are simply invoiced at the end of the billing period, at which point they can provide a payment method to settle the balance.
    • When Disabled: A valid payment method is required during the checkout process. The subscription cannot be activated until a payment method is successfully attached to the customer’s account.
  • Billing Alignment: This defines the “anchor point” for your recurring revenue. Choose between anniversary or calendar.
    • Anniversary: Billing cycles start on the exact date the subscription is activated. Each subsequent renewal is relative to that specific subscription start date (e.g., a monthly subscription started on March 12th will always renew on the 12th of each month).
    • Calendar: Billing cycles align to fixed calendar dates rather than the activation date. You can configure a specific anchor day (e.g., the 1st of the month) or a specific anchor month for each billing interval.
      • Prorate partial billing cycles: This setting determines how the system handles the financial calculation for subscriptions that begin in the middle of a pre-defined billing period.
        • When Enabled: When a subscription starts mid-cycle, the first cycle charge will be prorated based on the number of days remaining in the period. For example, if a $100/month calendar subscription (set to the 1st of the month) starts on the 15th, the customer is only invoiced for the remaining ~15 days of that month.
        • When Disabled: The customer is charged the full amount of the billing interval regardless of when they joined during the cycle.
These settings determine how the system reacts when a customer changes plan or changes their quantity of entitlements.
  • Upgrade Strategy: To ensure customers receive instant access to expanded features and higher limits, all upgrades are applied immediately at the moment the upgrade is done.
  • Downgrade Strategy: Choose how the system should handle transitions to a lower-priced tier. Choose either immediate or deferred.
    • Immediate: The plan change and associated feature restrictions are applied as soon as the customer changes to a lower tier.
    • Deferred: The customer retains access to their current higher-tier features until the end of the existing billing period. The downgrade only takes effect at the start of the next renewal cycle.
  • Apply credit for quantity downgrade: This toggle determines if customers receive a refund when reducing entitlement quantities. While the reduction in access is always immediate, the financial impact depends on this setting:
    • When Enabled: The “unused time” for the removed units are calculated and automatically issues a credit to the customer’s account.
    • When Disabled: No credit is issued for the “unused time”.
  • Allow customers to cancel: Customers can cancel their own subscriptions directly through the customer portal when enabled. When disabled, the cancellation option is hidden from the portal and customers must contact your support team to request a cancellation, allowing for manual retention efforts.
5

Configure Checkout Settings

The Checkout Settings menu controls how customers enter and exit your Metrifox-hosted checkout. Manage these at Settings → Checkout.
  • Signup Redirect URL: Where to send visitors who land on your Metrifox checkout page (via your pricing page) but don’t yet have a customer account in your system. Metrifox forwards them to this URL with offering_key and billing_interval query parameters so your app can create the account and then redirect them back to complete checkout. See the Generate Checkout URLs guide for the full flow.
  • Checkout Redirect URL: Where to send customers back to after they successfully complete checkout. If not set, customers land on Metrifox’s default success page and need a manual link to get back to your app. Setting this is strongly recommended for a clean post-purchase user experience.
Checkout Settings
6

Connect Your Payment Provider (PSP)

To live bills and collect payments, connect your Payment Service Provider (PSP). Metrifox seamlessly orchestrates the complex billing logic and sends the final invoice data to your PSP.
  • Currently Supported: Stripe, Paystack, Flutterwave
  • How to Connect:
    1. In the Metrifox dashboard, navigate to Integrations > Payments.
    2. Click Connect next to your chosen provider.
    3. Follow the instructions and connect.
👉 Next Step: Connect your PSP
7

Optional: Accept Manual Bank Payments

Prefer to collect payments out-of-band (bank transfer, cash, offline)? You can skip the PSP step and add your bank account instead — or use this alongside a PSP.
  1. Add your bank account at Settings → General → Business Bank Account.
  2. Turn on “Show bank account details” at Settings → Invoicing. This is what actually puts your bank details on issued invoices — adding the account alone doesn’t.
  3. Record incoming payments. When a customer pays, open the invoice at Billings → Invoices → [invoice] and click Record Manual Payment to mark it paid.
👉 Add your bank account · View invoices