# Freemius Developer Documentation > Technical guides, API reference, and answers for integrating Freemius to sell and monetize SaaS applications, software, WordPress plugins and themes, and digital products. ## help ### Documentation & Guides #### affiliate-platform Freemius offers a free, out-of-the-box affiliate solution for your sales needs. Check out the details here. - [Affiliate Platform](https://freemius.com/help/documentation/affiliate-platform.md): Freemius offers a free, out-of-the-box affiliate solution for your sales needs. Check out the details here. - [Giving Coupons to Your Affiliates to Boost Promotions](https://freemius.com/help/documentation/affiliate-platform/affiliate-coupon.md): Learn how to create and assign coupons to your affiliates in the Freemius Developer Dashboard to help them promote your products effectively. - [Activating The Affiliate Program](https://freemius.com/help/documentation/affiliate-platform/affiliate-program-activation.md): Activate the affiliate program in your Freemius Dashboard with easy instructions. Learn more here. - [Affiliate Terms Customization](https://freemius.com/help/documentation/affiliate-platform/affiliate-terms-customization.md): Customize affiliate terms easily for each partner. Just scroll to the affiliate's details and toggle the Customize Terms switch. - [Known Affiliate Link Issues](https://freemius.com/help/documentation/affiliate-platform/known-affiliate-link-issues.md): Discover the common affiliate link issues and learn about the solutions here. - [Onboarding Affiliate Marketers](https://freemius.com/help/documentation/affiliate-platform/onboarding-affiliate-marketers.md): Step-by-step instructions to onboard affiliate marketers for your products in your Freemius Developer Dashboard. - [Paying Affiliates Commission](https://freemius.com/help/documentation/affiliate-platform/paying-affiliates-commission.md): Learn how to manage monthly affiliate commission payouts with Freemius. #### ai Use Freemius tools and integrations to build and monetize AI-powered products with LLMs and AI agents. - [Build with LLMs, AI Coding Agents and No-Code Platforms](https://freemius.com/help/documentation/ai.md): Use Freemius tools and integrations to build and monetize AI-powered products with LLMs and AI agents. - [Integrate Freemius Billing and Monetization with Antigravity CLI](https://freemius.com/help/documentation/ai/antigravity-cli.md): Learn how to use Antigravity CLI to integrate Freemius checkout, entitlements, and customer portal monetization into your SaaS product. - [Bolt Integration Guide with Freemius](https://freemius.com/help/documentation/ai/bolt.md): Learn how to easily integrate Freemius Monetization with your apps and SaaS built on Bolt.new with a single prompt to your AI agent. - [Integrate Freemius Billing and Monetization with Claude Code](https://freemius.com/help/documentation/ai/claude.md): Learn how to use Claude Code to integrate Freemius checkout, entitlements, and customer portal monetization into your SaaS product. - [Integrate Freemius Billing and Monetization with ChatGPT Codex](https://freemius.com/help/documentation/ai/codex.md): Learn how to use ChatGPT Codex to integrate Freemius checkout, entitlements, and customer portal monetization into your SaaS product. - [Integrate Freemius Billing and Monetization with Command Code](https://freemius.com/help/documentation/ai/command-code.md): Learn how to use Command Code to integrate Freemius checkout, entitlements, and customer portal monetization into your SaaS product. - [Integrate Freemius Billing and Monetization with Cursor](https://freemius.com/help/documentation/ai/cursor.md): Learn how to use Cursor to integrate Freemius checkout, entitlements, and customer portal monetization into your SaaS product. - [Lovable Integration Guide with Freemius](https://freemius.com/help/documentation/ai/lovable.md): Learn how to easily integrate Freemius Monetization with your apps and SaaS built on Lovable.dev with a single prompt to your AI agent. - [Integrate Freemius Billing and Monetization with OpenCode](https://freemius.com/help/documentation/ai/opencode.md): Learn how to use OpenCode to integrate Freemius checkout, entitlements, and customer portal monetization into your SaaS product. - [Integrate Freemius Billing and Monetization with AI Agent Skills](https://freemius.com/help/documentation/ai/skills.md): Learn how to install Freemius AI Agent Skills and use Claude Code, Codex, Cursor, and other AI coding agents to integrate checkout, entitlements, and customer portal monetization into your SaaS. - [Sticklight Integration Guide with Freemius](https://freemius.com/help/documentation/ai/sticklight.md): Learn how to easily integrate Freemius Monetization with your apps and SaaS built on Sticklight.com with a single prompt to your AI agent. #### analytics Freemius comes with smart analytics bundled in to make your product development and marketing more efficient and logical. Learn more here. - [Sales and Usage Analytics with Freemius](https://freemius.com/help/documentation/analytics.md): Freemius comes with smart analytics bundled in to make your product development and marketing more efficient and logical. Learn more here. - [Audience Analytics](https://freemius.com/help/documentation/analytics/audience.md): Explore the Freemius Analytics Dashboard for user behavior and demographics data visualization. - [Calculating Churn Rate](https://freemius.com/help/documentation/analytics/calculating-churn-rate.md): Learn how to calculate churn rate effectively using data from Freemius using customer cancellations, optimize retention & subscription churn. - [Sales Analytics](https://freemius.com/help/documentation/analytics/sales.md): Discover the Freemius Analytics Dashboard for sales performance data visualization. - [User & Websites Data](https://freemius.com/help/documentation/analytics/user-data.md): Unlock data-driven decisions for your WordPress products with Freemius Insights advanced analytics. Learn more here. - [User Feedback](https://freemius.com/help/documentation/analytics/user-feedback.md): Freemius helps you understand your users' opinions with a user-friendly, non-intrusive deactivation feedback form. Now it's easier and cheaper to retain a user. #### checkout The Freemius Checkout is a secure, embeddable checkout solution crafted to help software makers sell their products effortlessly. Whether you are selling SaaS, WordPress plugins, desktop apps, or web browser extensions, Freemius offers a seamless and secure payment experience for your customers, accepting global payments without writing custom code. - [Checkout](https://freemius.com/help/documentation/checkout.md): The Freemius Checkout is a secure, embeddable checkout solution crafted to help software makers sell their products effortlessly. Whether you are selling SaaS, WordPress plugins, desktop apps, or web browser extensions, Freemius offers a seamless and secure payment experience for your customers, accepting global payments without writing custom code. - [Customization of the Freemius Checkout](https://freemius.com/help/documentation/checkout/customization.md): Explore various ways to customize the Freemius checkout to align with your brand and enhance user experience. - [Customize Checkout Style with CSS](https://freemius.com/help/documentation/checkout/customization/applying-css-customization.md): How to apply CSS customization to Freemius Checkout - [Customizing the After Purchase Confirmation Dialog](https://freemius.com/help/documentation/checkout/customization/customizing-confirmation-dialog.md): Customize what is shown in the confirmation dialog after a successful purchase. - [The Freemius Checkout Features](https://freemius.com/help/documentation/checkout/features.md): Explore the powerful features of the Freemius checkout - [How Automatic Discounts Work in the Checkout](https://freemius.com/help/documentation/checkout/features/automatic-discounts-in-checkout.md): The Freemius guide on how automatic discounts calculated dynamically based on product pricing and configurations are applied during checkout - [Showing a Dedicated UI for Changing the Billing Cycle](https://freemius.com/help/documentation/checkout/features/billing-cycle-selector-ui.md): Enable a dedicated billing cycle selector UI in Freemius Checkout to allow buyers to choose their preferred billing cycle during purchase. - [Effectively use Coupons with the Freemius Checkout](https://freemius.com/help/documentation/checkout/features/coupons.md): Learn how to apply coupons in Freemius Checkout to offer discounts and promotions to your customers. - [Freemius Checkout GDPR and Privacy-Related Compliance](https://freemius.com/help/documentation/checkout/features/gdpr.md): Understand how Freemius Checkout complies with GDPR and related privacy regulations, and what measures are in place to protect user data. - [Sell in Local Languages and Currencies with Automatic Detection](https://freemius.com/help/documentation/checkout/features/local-languages-currencies.md): Automatically detect and set the best language and currency in Freemius Checkout based on your customer\'s locations, and learn how to customize these settings. - [Prepopulate user information in the Freemius Checkout](https://freemius.com/help/documentation/checkout/features/pre-populate-user-info.md): Learn how to use the User Token feature to prepopulate user information in the Freemius Checkout. - [Providing Prorated Discounts on Upgrades & Downgrades in Freemius Checkout](https://freemius.com/help/documentation/checkout/features/proration.md): How Freemius handles prorating upgrades and downgrades, simplifying billing for customers, and ensuring sellers receive the right value. - [Showing Reviews and Money-Back Guarantee in the Checkout](https://freemius.com/help/documentation/checkout/features/social-proofing-ui.md): Enhance sales conversion by displaying a featured review and a money-back guarantee in the Freemius checkout. - [Add Event listeners & Analytics Tracking in the Checkout](https://freemius.com/help/documentation/checkout/features/tracking-analytics.md): Learn how to add analytics tracking to the Freemius checkout to monitor user interactions and purchases. - [Showing Annual, Lifetime, and Unlimited Upsell Toggles in the Checkout](https://freemius.com/help/documentation/checkout/features/upsell-toggles.md): Increase sales conversion by displaying upsell toggles for annual, lifetime, and unlimited plans in the Freemius checkout. - [The Freemius Checkout Integration Guide](https://freemius.com/help/documentation/checkout/integration.md): Learn how to seamlessly integrate the Freemius checkout into your application - [API and Configuration for Freemius Checkout](https://freemius.com/help/documentation/checkout/integration/freemius-checkout-buy-button.md): Selling with Freemius is easy to configure. We provide you with a ready-to-use simple JavaScript snippet that you can embed on any website. - [Generating License Renewal & Payment Method Update Links](https://freemius.com/help/documentation/checkout/integration/generate-renewal-payment-method-update-link.md): Our platform provides a Customer Portal from where your customers can self-serve to renew expired licenses or update billing methods. However, sometimes sharing a direct link helps in quicker conversion. - [Hosted Checkout](https://freemius.com/help/documentation/checkout/integration/hosted-checkout.md): Learn how to use Freemius Hosted Checkout to redirect customers to a specific URL for completing their purchases. - [Sell Directly from Your Website with Freemius Checkout Overlay](https://freemius.com/help/documentation/checkout/integration/overlay-checkout.md): Learn how to integrate Freemius Checkout Overlay into your website to provide a seamless purchasing experience for your customers. - [Testing the Freemius Checkout via Sandbox](https://freemius.com/help/documentation/checkout/integration/testing.md): Mimic the live production environment to test the checkout process before launching your product. #### emails Learn how to manage Freemius emails sent to buyers and users, including transactional email types, branding, content customization, sender settings, and deliverability best practices. - [Freemius Email Management and Customization](https://freemius.com/help/documentation/emails.md): Learn how to manage Freemius emails sent to buyers and users, including transactional email types, branding, content customization, sender settings, and deliverability best practices. - [Customize Transactional Email Content](https://freemius.com/help/documentation/emails/email-content-customization.md): Add custom content blocks to your Freemius transactional emails to include onboarding instructions, download links, support resources, and other valuable information for your customers. - [Email Deliverability](https://freemius.com/help/documentation/emails/email-deliverability.md): Freemius relies on SendGrid for transactional emails, ensuring exceptional deliverability. - [Customize Email Sender and Reply-To Addresses](https://freemius.com/help/documentation/emails/email-settings.md): Customize the sender and reply-to email addresses used in transactional emails sent to customers at both the store and product levels. - [Email Style Customization](https://freemius.com/help/documentation/emails/email-style-customization.md): The Email Styler is a powerful visual editor that allows you to fully customize the look and feel of transactional emails sent to your users and customers via Freemius. This tool ensures your emails reflect your unique brand identity, enhancing trust, recognition, and engagement. - [Automated Emails Sent by Freemius](https://freemius.com/help/documentation/emails/transactional-emails.md): Guide to all automated emails sent by Freemius: purchases, trials, renewals, marketing automation sequences, and customization options. #### getting-started Discover the essential steps to begin selling your WordPress plugins or themes on Freemius. Click here to get started. - [Getting Started with Freemius](https://freemius.com/help/documentation/getting-started.md): Discover the essential steps to begin selling your WordPress plugins or themes on Freemius. Click here to get started. - [Advanced Topics](https://freemius.com/help/documentation/getting-started/advanced-topics.md): Learn about some of the more advanced features available with Freemius. - [Creating an Account](https://freemius.com/help/documentation/getting-started/creating-an-account.md): Access the comprehensive documentation articles for Freemius, the leading payments platform for software makers. - [Explore the Developer Dashboard](https://freemius.com/help/documentation/getting-started/explore-the-developer-dashboard.md): The Developer Dashboard is your main portal to the Freemius platform. In it, you can track important statistics, such as product sales and user opt-ins, manage products, licenses, customers, and much more! - [Explore the Customer Portal](https://freemius.com/help/documentation/getting-started/explore-the-user-dashboard.md): One of the most important aspects of selling a plugin or theme is allowing your users to manage their relationship with you. - [Integrating your First product](https://freemius.com/help/documentation/getting-started/integrating-your-first-product.md): Integrating Freemius into your product is faster than you might expect. With our step-by-step workflow, you can sign up, integrate, and start selling—all in the same day. - [Making Your First Sale](https://freemius.com/help/documentation/getting-started/making-your-first-sale.md): Welcome to your first steps selling through Freemius! This guide will help you set up and test your checkout/buy button to ensure everything is working perfectly before going live. - [Our Pricing](https://freemius.com/help/documentation/getting-started/our-pricing.md): Get to know what it will cost to use Freemius before making your first sale. With Freemius’ revenue-sharing model, pay when you make your first sale - [WordPress & Templates Pricing](https://freemius.com/help/documentation/getting-started/saas-vs-wordpress-pricing.md): Learn about the differences between our SaaS & Software and WordPress & Templates pricing plans to choose the right one for your business. - [Where to Get Help](https://freemius.com/help/documentation/getting-started/where-to-get-help.md): Occasionally, everyone needs a little support. Here's a rundown of the best places to get help with any business challenges or technical aspects of using Freemius. #### integrations Elevate your plugin’s potential with seamless integrations | Freemius documentation – your gateway to integration excellence - [3rd Party Integrations](https://freemius.com/help/documentation/integrations.md): Elevate your plugin’s potential with seamless integrations | Freemius documentation – your gateway to integration excellence - [AppSumo & Lifetime Deals](https://freemius.com/help/documentation/integrations/appsumo-lifetime-deals.md): Discover how to integrate AppSumo or any LTD partners with Freemius for exclusive opportunities. Get started with our comprehensive documentation today. - [Help Scout Integration](https://freemius.com/help/documentation/integrations/help-scout.md): Enhance customer support with Help Scout integration – simplify user interactions & streamline support processes with Freemius. Boost satisfaction today! - [MailChimp Integration](https://freemius.com/help/documentation/integrations/mailchimp-integration.md): Freemius MailChimp integration allows you to seamlessly connect your email marketing campaigns with your Freemius user base. Learn how here. #### marketing-automation Learn how to use Freemius marketing automation tools to recover abandoned carts, manage failed payments, offer targeted discounts, and use reviews to increase conversions and reduce churn. - [Freemius Marketing Automation](https://freemius.com/help/documentation/marketing-automation.md): Learn how to use Freemius marketing automation tools to recover abandoned carts, manage failed payments, offer targeted discounts, and use reviews to increase conversions and reduce churn. - [Cart Abandonment Recovery](https://freemius.com/help/documentation/marketing-automation/cart-abandonment-recovery.md): Freemius comes with a fully-featured Cart Abandonment Recovery mechanism. Find out how it works here. - [Dunning & Failed Payments](https://freemius.com/help/documentation/marketing-automation/dunning-failed-payments.md): Explore Freemius' failed payment approach, including dunning process, email alerts, and payment retry schedules for PayPal and credit card transactions. - [Boost Conversions with Collected Ratings and Reviews](https://freemius.com/help/documentation/marketing-automation/reviews.md): Boost your conversions with user ratings and reviews. Freemius automates review collection with no additional setup required. - [Special Coupons & Discounts](https://freemius.com/help/documentation/marketing-automation/special-coupons-discounts.md): Enhance your subscription-based model with special discounts. Access four exclusive offers in the Freemius Developer Dashboard for a better commercial experience. #### migration Easily migrate to Freemius and seamlessly transition your digital products from other platforms with our expert guidance. - [Migration](https://freemius.com/help/documentation/migration.md): Easily migrate to Freemius and seamlessly transition your digital products from other platforms with our expert guidance. - [Migrating from CodeCanyon to Freemius](https://freemius.com/help/documentation/migration/migrating-from-codecanyon-to-freemius.md): Switch from CodeCanyon to Freemius with our step-by-step guide. Migrate customers and harness marketing automation. Make the transition today! - [Migrating from Easy Digital Downloads to Freemius](https://freemius.com/help/documentation/migration/migrating-from-edd-to-freemius.md): Easily migrate from EDD to Freemius. Streamline licensing, updates, and reduce server load today. - [Migrating from ThemeForest to Freemius](https://freemius.com/help/documentation/migration/migrating-from-themeforest-to-freemius.md): Effortlessly switch from ThemeForest to Freemius. Sell with confidence, migrate customers, and gain access to ultra-sophisticated features. #### release-management Learn about deployment, versioning, and release tools with Freemius to streamline your software updates to your users - [Deliver new features to your users](https://freemius.com/help/documentation/release-management.md): Learn about deployment, versioning, and release tools with Freemius to streamline your software updates to your users - [Deploy New Product Version with Freemius](https://freemius.com/help/documentation/release-management/deployment.md): Learn how to deploy new versions of your WordPress products and templates using Freemius' built-in deployment system, including manual and automated methods. - [Software Updates Distribution](https://freemius.com/help/documentation/release-management/distribution.md): Find out how software updates are distributed with Freemius, including WordPress SDK integration and Customer Portal downloads. - [Incremental Versions Support](https://freemius.com/help/documentation/release-management/incremental-update.md): The Incremental Versions Support (also known as Sequential or Staged Upgrades or Dependency Upgrade) feature allows to control the flow of the update process. When a version is marked as incremental, customers must first update to that version before they can update to any subsequent versions. - [Utilizing semantic versioning in Release Management](https://freemius.com/help/documentation/release-management/semantic-versioning.md): Guidelines for using semantic versioning in Freemius release management. - [Staged Rollouts](https://freemius.com/help/documentation/release-management/staged-rollouts.md): Elevate your software updates with Freemius Staged Rollouts. Safely release paid versions step by step for enhanced update confidence. #### saas-sdk Welcome to the Freemius SaaS SDKs & Starter Kits documentation! Freemius already provides straightforward Checkout Integration, a robust API, and a Webhook system, making it easy to integrate Freemius Monetization into your SaaS applications. - [Integrate Freemius with your SaaS Application using SDKs & Starter Kits](https://freemius.com/help/documentation/saas-sdk.md): Welcome to the Freemius SaaS SDKs & Starter Kits documentation! Freemius already provides straightforward Checkout Integration, a robust API, and a Webhook system, making it easy to integrate Freemius Monetization into your SaaS applications. - [Embed Overlay Checkout with the Checkout JavaScript SDK](https://freemius.com/help/documentation/saas-sdk/checkout-js-sdk.md): Learn how to integrate Freemius Checkout into your web applications using the JavaScript SDK. - [Freemius Checkout JS SDK Installation](https://freemius.com/help/documentation/saas-sdk/checkout-js-sdk/installation.md): Installation guide for the Freemius Checkout JavaScript SDK. - [Migration Guide](https://freemius.com/help/documentation/saas-sdk/checkout-js-sdk/migration.md): Migration guide for the Freemius Checkout JavaScript SDK version upgrade. - [Using the Freemius Checkout JS SDK to Embed the Overlay Checkout](https://freemius.com/help/documentation/saas-sdk/checkout-js-sdk/usage.md): Usage guide for the Freemius Checkout JavaScript SDK. - [Framework Integration Guide for SaaS Applications](https://freemius.com/help/documentation/saas-sdk/framework.md): A guide on how to integrate the Freemius JS/TS SDK with various frameworks - [Integrating with Express](https://freemius.com/help/documentation/saas-sdk/framework/express.md): Learn how to integrate Freemius with your Express server for seamless backend operations. - [Integrating with Fastify](https://freemius.com/help/documentation/saas-sdk/framework/fastify.md): Learn how to integrate Freemius with your Fastify server for seamless backend operations. - [Integrating with Hono](https://freemius.com/help/documentation/saas-sdk/framework/hono.md): Learn how to integrate Freemius with your Hono server for seamless backend operations. - [Next.js Integration Guide with JavaScript SDK & Starter Kit](https://freemius.com/help/documentation/saas-sdk/framework/nextjs.md): A comprehensive guide to building and monetizing a SaaS application using Next.js, Freemius JS/TS SDK, and the React Starter Kit - [Integrating with Nuxt](https://freemius.com/help/documentation/saas-sdk/framework/nuxt.md): Learn how to integrate Freemius with your Nuxt App for seamless operations and Checkout. - [JavaScript Software Development Kit for Freemius](https://freemius.com/help/documentation/saas-sdk/js-sdk.md): Freemius offers a JS SDK written in TypeScript to help you integrate Freemius into your SaaS applications built with Node.js, Bun etc. - [API Reference for the TypeScript Node.js SDK](https://freemius.com/help/documentation/saas-sdk/js-sdk/api.md): Comprehensive API reference for the Freemius TypeScript Node.js SDK, detailing all classes, methods, and types. - [Checkout with the TypeScript Node.js SDK](https://freemius.com/help/documentation/saas-sdk/js-sdk/checkout.md): Guide on how to implement and manage the checkout process using the Freemius TypeScript Node.js SDK. - [Implementing your own Customer Portal inside your SaaS with Freemius JS SDK](https://freemius.com/help/documentation/saas-sdk/js-sdk/customer-portal.md): Learn how to create a custom customer portal using the Freemius TypeScript Node.js SDK to manage subscriptions, licenses, and billing information. - [Installation Guide for the Freemius JS/TS SDK](https://freemius.com/help/documentation/saas-sdk/js-sdk/installation.md): This guide will help you install and set up the Freemius JavaScript SDK in your SaaS application. - [Integrating the Freemius JS SDK into Your Application](https://freemius.com/help/documentation/saas-sdk/js-sdk/integration.md): Guide on how to integrate the Freemius JavaScript SDK into your SaaS application following best practices and conventions. - [Managing Purchases with the JS SDK](https://freemius.com/help/documentation/saas-sdk/js-sdk/purchases.md): Guide on how to retrieve purchase information, purchase data, and subscriptions using the Freemius TypeScript Node.js SDK. - [Create API Endpoints needed for the React Starter Kit](https://freemius.com/help/documentation/saas-sdk/js-sdk/starter-kit-api-endpoints.md): Learn how to create the necessary API endpoints for the React Starter Kit using the Freemius SaaS SDK. - [Creating Webhook Listeners with Freemius JS SDK](https://freemius.com/help/documentation/saas-sdk/js-sdk/webhooks.md): Guide on how to implement and manage webhook listeners using the Freemius TypeScript Node.js SDK. - [React Starter Kit](https://freemius.com/help/documentation/saas-sdk/react-starter.md): A starter kit for building SaaS applications with React and integrating Freemius - [Various Components and Features](https://freemius.com/help/documentation/saas-sdk/react-starter/components.md): Various components for building SaaS applications with React and integrating with Freemius - [Installing the Starter Kit and Integrating with JS SDK](https://freemius.com/help/documentation/saas-sdk/react-starter/installation.md): A guide on how to install the React Starter Kit and integrate it with the Freemius JS/TS SDK - [Changing the Text or Language of the Components](https://freemius.com/help/documentation/saas-sdk/react-starter/localization.md): A guide on how to change the text or language of the React Starter Kit components #### saas Freemius makes it easy to monetize and license SaaS products, desktop apps, browser extensions, and other software. - [Setup for SaaS and Apps](https://freemius.com/help/documentation/saas.md): Freemius makes it easy to monetize and license SaaS products, desktop apps, browser extensions, and other software. - [App Integration](https://freemius.com/help/documentation/saas/app-integration.md): This guide covers integrating an application that includes a license activation flow. Examples include desktop apps (macOS or Windows), Chrome extensions, Electron apps, and more. - [Custom Download Links for Apps & Products](https://freemius.com/help/documentation/saas/custom-download-links.md): Set up custom download links for your apps and allow customers to access their downloads with automatic license key integration after purchase. - [Customize License Unit Label](https://freemius.com/help/documentation/saas/customize-license-unit-label.md): Customize the units of measure for the digital product being sold for SaaS and Applications - [Automate Your Workflows with Events & Webhooks](https://freemius.com/help/documentation/saas/events-webhooks.md): Learn how to automate email marketing and enable real-time communication between your backend systems and Freemius with events and webhooks - [Integrating License Key Activation](https://freemius.com/help/documentation/saas/integrating-license-key-activation.md): This guide covers software such as desktop apps (macOS or Windows), Chrome extensions, and SaaS products that rely on license key activation. - [iOS In-App Purchase Integration](https://freemius.com/help/documentation/saas/ios-in-app-purchase-integration.md): In this guide, you will learn how to use the Freemius Hosted Checkout to provide an in-app purchase experience from your iOS apps without using Apple Checkout. - [Integrating Freemius into Your SaaS Application](https://freemius.com/help/documentation/saas/saas-integration.md): A step-by-step guide to integrating Freemius into your SaaS application, covering checkout integration, license management, webhooks, and customer portal setup. - [Setup Plans & Pricing to Support Subscriptions and One-Off Purchases](https://freemius.com/help/documentation/saas/saas-plans-pricing.md): Learn how to configure pricing plans for your users, each with distinct billing cycles, prices, unit counts (e.g., seats, devices, credits), currencies, and feature sets. - [Setup Recommended Refund Policy for your SaaS or App](https://freemius.com/help/documentation/saas/setup-refund-policy.md): Set up a refund policy for your SaaS or App sold through Freemius. Explore our recommendations and available options. - [Set Up Usage-Based Billing with Prepaid Credits](https://freemius.com/help/documentation/saas/usage-based-billing-credits.md): Learn how to sell prepaid AI credits and top-ups for metered and consumptive features in your SaaS product. #### security Learn all about securing your Developer Dashboard account. - [Security](https://freemius.com/help/documentation/security.md): Learn all about securing your Developer Dashboard account. - [Team Member & Role Management](https://freemius.com/help/documentation/security/team-member-role-management.md): Manage who can access a product and roles via the Team section in the Developer Dashboard. - [Two-Factor Authentication (2FA)](https://freemius.com/help/documentation/security/two-factor-authentication-2fa.md): Freemius Developer Dashboard supports Two-Factor Authentication (2FA) to protect your account against unauthorized access. #### selling-templates Learn how to set up templates and kits for sale using Freemius. - [Selling Templates](https://freemius.com/help/documentation/selling-templates.md): Learn how to set up templates and kits for sale using Freemius. - [Deploying your Files](https://freemius.com/help/documentation/selling-templates/deployments.md): Learn how to deploy your template files for sale using Freemius. - [Distributing your Templates and Providing Updates](https://freemius.com/help/documentation/selling-templates/distribution.md): Learn how to distribute your template files and provide updates to your customers using Freemius. - [Set Download and Installation Instructions](https://freemius.com/help/documentation/selling-templates/installation-instruction.md): Learn how to set up download and installation instructions for your template files using Freemius. - [Setup Product, Plans & Pricing](https://freemius.com/help/documentation/selling-templates/templates-plans-pricing.md): Learn how to set up templates and kits for sale using Freemius. #### selling-with-freemius Unlock the ultimate guide to secure and easy selling with Freemius. Your comprehensive solution for software product sales. - [Selling with Freemius](https://freemius.com/help/documentation/selling-with-freemius.md): Unlock the ultimate guide to secure and easy selling with Freemius. Your comprehensive solution for software product sales. - [Allowed & Prohibited Products](https://freemius.com/help/documentation/selling-with-freemius/allowed-prohibited-products.md): Freemius is exclusively focused on serving makers selling software like SaaS and downloadable software. We do not support the selling of physical goods or human services like consultations. We also don’t allow anything illegal, harmful, abusive, deceptive, or sketchy—our goal is to support trustworthy makers building real software businesses. - [How to Transfer a Product Between Different Stores](https://freemius.com/help/documentation/selling-with-freemius/change-product-store.md): Learn how to transfer products between different stores in Freemius without affecting subscriptions and licenses. - [Setting up Coupon Discounts with Configurable Segments, Types & Plans](https://freemius.com/help/documentation/selling-with-freemius/coupon-discount.md): Configure coupon discounts in Freemius: lifespan, types, renewals, plans, pricings, billing cycles, and eligibility. - [The License Renewals Mechanism](https://freemius.com/help/documentation/selling-with-freemius/license-renewals-mechanism.md): Learn about Freemius subscription renewals, automated dunning campaigns, and the renewal process, ensuring uninterrupted access to your product. - [Multi-Currency Pricing & Support](https://freemius.com/help/documentation/selling-with-freemius/multi-currency.md): Learn how to boost your plugin or theme sales with multi-currency pricing and support on Freemius. Discover how to customize your currency options. - [Product Retirement](https://freemius.com/help/documentation/selling-with-freemius/product-retirement.md): How to Retire a Product on Freemius - considerations and practices for retiring a product on Freemius. - [Refund Payment](https://freemius.com/help/documentation/selling-with-freemius/refund-payment.md): This document outlines the various refund options and procedures available to software makers using Freemius. - [How to Set up a Refund Policy for Your Product](https://freemius.com/help/documentation/selling-with-freemius/refund-policy.md): Learn how to configure a refund policy for your products sold through Freemius. Follow our step-by-step guide and explore recommended policies. - [How to Offer Trials With or Without Requiring a Payment Method](https://freemius.com/help/documentation/selling-with-freemius/set-up-trials.md): Learn how to configure trial periods in the Freemius Checkout to encourage more users to try your product before purchasing. - [So, what exactly does it do?](https://freemius.com/help/documentation/selling-with-freemius/so-what-does-freemius-do.md): Learn about the features and benefits of selling your software products with Freemius, including checkout options, tax compliance, and more. - [Supported Countries](https://freemius.com/help/documentation/selling-with-freemius/supported-countries.md): Freemius Checkout supports payments from nearly every country worldwide, as long as the region is not under U.S. sanctions. - [Complete Verification to Start Selling in Production](https://freemius.com/help/documentation/selling-with-freemius/verification.md): Learn how to complete the verification process to start selling your product in production - [Check Earnings, Setup Payout Methods and Get Paid with Freemius](https://freemius.com/help/documentation/selling-with-freemius/your-earnings.md): Check your current earnings status in your account and learn how Freemius handles payouts to its partners (sellers) #### users-account-management Learn how your users and customers can manage their account and find support. - [Enable your customers to manage their account and find support](https://freemius.com/help/documentation/users-account-management.md): Learn how your users and customers can manage their account and find support. - [Enable your customers to manage their license activations](https://freemius.com/help/documentation/users-account-management/activations.md): Learn how your users and customers can manage their app license activations - [Applying CSS Customization to the Customer Portal](https://freemius.com/help/documentation/users-account-management/applying-css-customization.md): Learn how to customize the appearance of the Freemius Customer Portal using CSS. - [Cancellation Survey: Collect User Feedback on Subscription Cancellations](https://freemius.com/help/documentation/users-account-management/cancellation-survey.md): Gather feedback from users when they cancel a subscription in the customer portal. - [Downloading Purchased Products](https://freemius.com/help/documentation/users-account-management/downloads.md): How your customers can access and download the latest versions of your downloadable software products including WordPress products and templates. - [Earn - Becoming an Affiliate](https://freemius.com/help/documentation/users-account-management/earn-becoming-an-affiliate.md): Freemius Makers have an affiliate program out of the box that enables their product users market the products they use and earn sales commission. - [Embed the Freemius Customer Portal into your website](https://freemius.com/help/documentation/users-account-management/embedding-customer-portal.md): Learn how to provide your customers with easy access to their accounts by adding a direct link to the Customer Portal on your website or embedding it directly into your site. - [Enhance the Security of Your Licenses with Freemius](https://freemius.com/help/documentation/users-account-management/license-security.md): Enhance the security of your licenses with Freemius' License Security features, including White Label Mode and URL Whitelisting (License Firewall). - [Generate Magic Links to Automatically Log in Customers to the Portal](https://freemius.com/help/documentation/users-account-management/magic-login-link.md): Learn how to generate magic links to allow your customers to automatically log in to the Customer Portal to manage their subscriptions, billing, and more. - [Orders History](https://freemius.com/help/documentation/users-account-management/orders-history.md): As a product user, this section enables you to see all your previous orders and their details. - [Single Sign-On for WordPress](https://freemius.com/help/documentation/users-account-management/sso-single-sign-on-wordpress.md): If you are using WordPress to power your website and like to allow users and customers to login to your WordPress with their Freemius credentials, you can use our official Single Sign-On WordPress Plugin. - [Support Integration in the Customer Portal](https://freemius.com/help/documentation/users-account-management/support-contact-form.md): Learn how to add customer support to the customer portal through tickets, docs and FAQ Integration #### wordpress-sdk Learn how the Freemius WordPress SDK features work including Opt-in screen customization, licensing handling, localization, testing, and debugging - [Exploring the Freemius WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk.md): Learn how the Freemius WordPress SDK features work including Opt-in screen customization, licensing handling, localization, testing, and debugging - [Customizing the Freemius WordPress SDK Integration](https://freemius.com/help/documentation/wordpress-sdk/customization.md): Customize the Freemius WordPress SDK integration in your plugin, theme, or addon to features in the Freemius platform. - [Customizing the Freemius WordPress SDK Integration with Constants](https://freemius.com/help/documentation/wordpress-sdk/customization/constants.md): Customize the Freemius WordPress SDK integration with constants in your plugin, theme, or addon to features in the Freemius platform. - [Filters & Actions Hooks](https://freemius.com/help/documentation/wordpress-sdk/customization/filters-actions-hooks.md): The Freemius SDK collection of filters and actions enables developers to customize and extend the functionality of their WordPress plugins or themes. - [Explore Gists to customize the Freemius WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk/customization/gists.md): Explore various code snippets and gists for customizing the Freemius WordPress SDK. - [Customize the Opt-in and License activation Screens](https://freemius.com/help/documentation/wordpress-sdk/customization/opt-in-screen.md): Customize the opt-in and License activation Screens of your WordPress plugin or theme integrated with the Freemius SDK to match your product's style and audience. - [Tabs Navigation](https://freemius.com/help/documentation/wordpress-sdk/customization/tabs-navigation.md): If you are worried about cluttering the WordPress admin menu, you can easily change the default navigation by implementing navigational tabs at the top of your plugin settings page. - [Customize the Text & Strings in the Freemius WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk/customization/text-strings-customization.md): Learn how to customize the text and strings used in the Freemius WordPress SDK. - [Debugging issues with the Freemius WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk/debugging.md): Enable and use the Freemius WordPress SDK debugging tools to troubleshoot and ensure a smooth integration process. - [Understanding the Freemius WordPress SDK Features](https://freemius.com/help/documentation/wordpress-sdk/features.md): Learn about the features of the Freemius WordPress SDK and how they can be used to enhance your plugin, theme, or addon integration with the Freemius platform. - [Have Your Customers Reach You in their WordPress Admin](https://freemius.com/help/documentation/wordpress-sdk/features/contacts.md): Enable the Contact Us page in the Freemius WordPress SDK to allow your customers to easily reach out to you for support directly from their WordPress admin dashboard. - [Exploring the Activation Screen](https://freemius.com/help/documentation/wordpress-sdk/features/opt-in-screen.md): Explore the opt-in screen and activation screen of your WordPress plugin or theme integrated with the Freemius SDK - [Manage your Freemius account from the WordPress Admin](https://freemius.com/help/documentation/wordpress-sdk/features/wp-admin-account.md): Manage your Freemius account directly from the WordPress Admin dashboard with the Freemius SDK. - [In-dashboard Upgrading in WP Admin](https://freemius.com/help/documentation/wordpress-sdk/features/wp-admin-in-dashboard-upgrading.md): When you integrate Freemius’ WordPress SDK into your plugin or theme, the free version automatically includes a pricing table and a purchase button, enabling customers to purchase directly from their WP Admin dashboard. We call this In-Dashboard Upgrading. - [Contributing to the Freemius WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk/freemius-sdk-contribute.md): A guide to contributing to the Freemius WordPress SDK codebase via GitHub. - [How the Freemius WordPress SDK Integration Works](https://freemius.com/help/documentation/wordpress-sdk/integration.md): Learn how to integrate the Freemius WordPress SDK into your plugin, theme, or addon. - [Integrate your Gutenberg Blocks with Freemius](https://freemius.com/help/documentation/wordpress-sdk/integration/gutenberg-block-integration.md): Integration Freemius with your Gutenberg Blocks made for the WordPress Block Editor. - [Understanding the Integration Snippet](https://freemius.com/help/documentation/wordpress-sdk/integration/integration-snippet.md): Learn about the SDK integration snippet, how to add it to your WordPress product, and how to configure it for optimal performance. - [Integrating WordPress Products for Multisites Networks](https://freemius.com/help/documentation/wordpress-sdk/integration/multisite-integration.md): Learn how to integrate the Freemius WordPress SDK into a multisite network environment, ensuring that your products function correctly across all sites in the network. - [Control Free and Premium WordPress Features with Freemius Licensing](https://freemius.com/help/documentation/wordpress-sdk/integration/software-licensing.md): Learn how to handle licensing in your WordPress plugin or theme with the Freemius SDK. - [Updating the Freemius WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk/integration/updating-wp-sdk.md): Learn when and how to update the Freemius WordPress SDK included in your WordPress plugin or theme. - [Known License Activation Issues](https://freemius.com/help/documentation/wordpress-sdk/license-activation-issues.md): Understand and resolve some common license activation issues to avoid unexpected problems when activating your product. - [Safe Mode & Clone Resolution](https://freemius.com/help/documentation/wordpress-sdk/safe-mode-clone-resolution-duplicate-website.md): Upon license key activation, Freemius assigns a unique ID and pair of public/secret keys tied to the website's URL. These are used for securely extending the license expiration date after subscription renewals, checking if there are new plugin/theme updates, and allowing customers to execute other account-related remote (or local) actions that get synced back to a website (or Freemius). - [Testing your product before releasing to production](https://freemius.com/help/documentation/wordpress-sdk/testing.md): How to test your product with the Freemius WordPress SDK integrated before releasing a version of it to production #### wordpress Get started with Freemius for your WordPress products. Learn how to set up, integrate, and manage your plugins, themes, blocks, widgets, and other products effectively. - [Start Selling WordPress Plugins, Themes, and Blocks with Freemius](https://freemius.com/help/documentation/wordpress.md): Get started with Freemius for your WordPress products. Learn how to set up, integrate, and manage your plugins, themes, blocks, widgets, and other products effectively. - [Deployment Process](https://freemius.com/help/documentation/wordpress/deployment-process.md): Deploy your WordPress plugin or theme to the Freemius Developer Dashboard to generate production-ready free and premium versions. - [Offering Free Trials](https://freemius.com/help/documentation/wordpress/free-trials.md): Offering free trials in the Freemius WordPress SDK may help you increase your product's distribution and sales. Here's how to set it up. - [Freemius for WordPress](https://freemius.com/help/documentation/wordpress/freemius-for-wordpress.md): Freemius for WordPress is a powerful WordPress plugin that enables you to add Freemius Checkout to any button of your WordPress content using the block editor. This makes it easy to integrate Freemius payment processing into your WordPress site with minimal effort. - [Integrating your WordPress product with the Freemius SDK](https://freemius.com/help/documentation/wordpress/integration-with-sdk.md): Integrate your WordPress plugin or theme with the Freemius WordPress SDK to start selling and managing your product. - [License Recovery Tool for WordPress Customers](https://freemius.com/help/documentation/wordpress/license-recovery-tool.md): Enable self-service license key and download link recovery for WordPress plugin and theme customers using only their email address, reducing support tickets. - [License Utilization](https://freemius.com/help/documentation/wordpress/license-utilization.md): Understand how Freemius license utilization works for live, staging, development, localhost, and multisite network environments. - [Next Steps](https://freemius.com/help/documentation/wordpress/next-steps.md): What to do after integrating the Freemius WordPress SDK to ensure a successful product launch. - [Selling Add-Ons / Extensions](https://freemius.com/help/documentation/wordpress/selling-add-ons-extensions.md): Freemius fully supports the add-ons business model, and the integration only takes a few minutes. You can sell add-ons for a plugin, and also for a theme! - [Selling Multiple WordPress Products as Bundles & Memberships](https://freemius.com/help/documentation/wordpress/selling-bundles-and-memberships.md): Learn how to create and manage bundles and memberships with Freemius, allowing you to sell multiple products together at a discounted price - [Configure Plans & Pricing for Your WordPress Product](https://freemius.com/help/documentation/wordpress/setup-product-pricing-plans-refunds.md): Configure pricing plans for your users, each with distinct feature sets, billing cycles, prices, and number of licenses with Freemius. - [Setting Up Your WordPress Plugins and Themes](https://freemius.com/help/documentation/wordpress/setup-products.md): Learn how to set up your WordPress product on the Freemius Developer Dashboard, including defining product details, configuring plans and pricing, and preparing for deployment. - [Setup Recommended Refund Policy for your WordPress Products](https://freemius.com/help/documentation/wordpress/setup-refund-policy.md): Set up a refund policy for your WordPress products sold through Freemius. Explore our recommendations and available options. - [Get your product and updates to your customers](https://freemius.com/help/documentation/wordpress/software-updates-distribution.md): Manage the distribution of free and premium versions of your WordPress plugin or theme, and how to handle software updates for your customers. ### API Reference Welcome to the Freemius API Documentation! - [Freemius RESTful APIv1](https://freemius.com/help/api.md): Welcome to the Freemius API Documentation! #### addons Addons - [Addons](https://freemius.com/help/api/addons.md): Addons - [List all plan's features](https://freemius.com/help/api/addons/list-plans-features.md): Retrieve the plan's features collection for the addon. - [List all plans](https://freemius.com/help/api/addons/list-plans.md): Retrieve the plans collection for the addon. - [List all pricings](https://freemius.com/help/api/addons/list-pricings.md): Retrieve the pricing collection for the addon for specific the plan. #### carts Carts - [Carts](https://freemius.com/help/api/carts.md): Carts - [List all carts](https://freemius.com/help/api/carts/list.md): Retrieve the cart collection associated with your product. - [Retrieve cart events](https://freemius.com/help/api/carts/retrieve-events.md): Get the list of events associated with a cart. - [Retrieve a cart](https://freemius.com/help/api/carts/retrieve.md): Retrieve cart details associated with the product. #### coupons Coupons - [Coupons](https://freemius.com/help/api/coupons.md): Coupons - [Create a note](https://freemius.com/help/api/coupons/create-note.md): Create a new note for a coupon. - [Create a special coupon](https://freemius.com/help/api/coupons/create-special.md): Create a special coupon. - [Create a coupon](https://freemius.com/help/api/coupons/create.md): Create a new coupon. - [Delete a note](https://freemius.com/help/api/coupons/delete-note.md): Delete a note for a coupon. - [Delete a special coupon](https://freemius.com/help/api/coupons/delete-special.md): Delete a special coupon by ID. - [Delete a coupon](https://freemius.com/help/api/coupons/delete.md): Delete a specific coupon by ID. - [List all coupons](https://freemius.com/help/api/coupons/list.md): Retrieve the coupon collection associated with your product. - [Retrieve a note](https://freemius.com/help/api/coupons/retrieve-note.md): Get the details of a note associated with a coupon. - [Retrieve special coupons](https://freemius.com/help/api/coupons/retrieve-special.md): Get the details of a special coupon. - [Retrieve a coupon](https://freemius.com/help/api/coupons/retrieve.md): Get details of a specific coupon by ID. - [Update a note](https://freemius.com/help/api/coupons/update-note.md): Update a note for a coupon. - [Update a coupon](https://freemius.com/help/api/coupons/update.md): Update a specific coupon's details by ID. #### deployments Deployments - [Deployments](https://freemius.com/help/api/deployments.md): Deployments - [Create a deployment](https://freemius.com/help/api/deployments/create.md): Upload a new version of the product (for WordPress products only). The endpoint supports only the `multipart/form-data` content type and expects two payloads: `file` and `data`. - [Download latest deployment](https://freemius.com/help/api/deployments/download-latest.md): Download the latest deployment the product has. This is for WordPress products only (including plugins, themes, templates and widgets). It outputs the zip file of the deployed version. - [Download a deployment](https://freemius.com/help/api/deployments/download.md): Download a specific deployed version of the product. This is for WordPress products only (including plugins, themes, templates and widgets). It outputs the zip file of the deployed version. - [Get latest deployment](https://freemius.com/help/api/deployments/get-latest.md): Get the information about the latest deployment the product has, including a secure download link. The download link will work without any authentication header and will expire in 24 hours. - [List all deployments](https://freemius.com/help/api/deployments/list.md): Get the product version collection. This is for WordPress products only. - [Update a deployment](https://freemius.com/help/api/deployments/update.md): Update a specific deployed version of the product. This applies to WordPress products only. Use this endpoint to update the `release_mode` of a deployment to make it available to your customers. #### events Events - [Events](https://freemius.com/help/api/events.md): Events - [List all events](https://freemius.com/help/api/events/list.md): Retrieve a list of events for a specific product. Supports filtering by type, state, and pagination. See the [documentation](https://freemius.com/help/documentation/saas/events-webhooks/#how_to_create_a_webhook) for instructions on creating a webhook to listen for events. - [Retrieve an event](https://freemius.com/help/api/events/retrieve.md): Retrieve a specific event by its ID. For instructions on creating webhook listeners, see the [documentation](https://freemius.com/help/documentation/saas/events-webhooks/#how_to_create_a_webhook). #### installations Installations - [Installations](https://freemius.com/help/api/installations.md): Installations - [Activate a license](https://freemius.com/help/api/installations/activate-license.md): Activate license for an install. - [Cancel a trial](https://freemius.com/help/api/installations/cancel-trial.md): Cancel a trial associated with a specific install. - [Create a new license](https://freemius.com/help/api/installations/create-new-license.md): Create a new license and assign it to the install. - [Deactivate a license](https://freemius.com/help/api/installations/deactivate-license.md): Deactivate license from an install. - [Delete an install](https://freemius.com/help/api/installations/delete-install.md): Delete a product install. This is different from an uninstall. - [Downgrade to the default plan](https://freemius.com/help/api/installations/downgrade-default-plan.md): Downgrade install's plan to product’s default plan. This is usually the free plan. - [List all active licenses](https://freemius.com/help/api/installations/list-active-licenses.md): Retrieve the active licenses (usually only one) on an install. - [List all events](https://freemius.com/help/api/installations/list-events.md): Retrieve the event collection related to a product install. - [List all installs](https://freemius.com/help/api/installations/list-installs.md): Retrieve the install collection associated with the product. - [List all market items](https://freemius.com/help/api/installations/list-market-items.md): Retrieves all market items associated with an `Install` entity. - [List all payments](https://freemius.com/help/api/installations/list-payments.md): Retrieve the payment associated with the install. - [List all plan's features for Addon](https://freemius.com/help/api/installations/list-plans-features-for-addon.md): Get plan's features collection for an addon on a site. - [List all plans](https://freemius.com/help/api/installations/list-plans.md): Retrieve all the available product plans to which an install can subscribe. - [List all updates](https://freemius.com/help/api/installations/list-updates.md): Retrieve the product update collection available for an install. - [Retrieve an active license by ID](https://freemius.com/help/api/installations/retrieve-active-license-by-id.md): Retrieve specific license of the install when the license ID and the license key are known but the UID of the install is not known. - [Retrieve an active license by UID](https://freemius.com/help/api/installations/retrieve-active-license-by-uid.md): Retrieve the full information about the active license for the specified install when the UID of the install is known. - [Retrieve an install](https://freemius.com/help/api/installations/retrieve-install.md): Retrieve the details related to the product install. - [Retrieve installs count](https://freemius.com/help/api/installations/retrieve-installs-count.md): Retrieve the number of installs associated with the product. - [Retrieve the latest update](https://freemius.com/help/api/installations/retrieve-latest-update.md): Retrieve the latest product update available for an install. - [Retrieve a plan](https://freemius.com/help/api/installations/retrieve-plan.md): Retrieve the product plan details to which the install is subscribed. - [Retrieve uninstall details](https://freemius.com/help/api/installations/retrieve-uninstall-details.md): Retrieve the details of an install where the product has been uninstalled. - [Start a trial](https://freemius.com/help/api/installations/start-trial.md): Start the trial of a plan for which an install is subscribed. The install must not have utilized the trial before. - [Update an install](https://freemius.com/help/api/installations/update-install.md): Update the details related to the product install. - [Update permissions](https://freemius.com/help/api/installations/update-permissions.md): Update permissions to a product install. #### licenses Licenses - [Licenses](https://freemius.com/help/api/licenses.md): Licenses - [Activate a license](https://freemius.com/help/api/licenses/activate.md): Activate a license and if needed, create an install with the given properties. - [Assign a license](https://freemius.com/help/api/licenses/assign.md): Associate an orphan license with a user and send a welcome email. If the user does not exist yet, one will be created. - [Cancel current subscription](https://freemius.com/help/api/licenses/cancel-current-subscription.md): Use this endpoint to **cancel the active subscription** associated with a license. If the license is currently in a **trialing state**, this will also cancel the trial. - [Cancel a license](https://freemius.com/help/api/licenses/cancel.md): Cancel or delete a license. The Delete action is irreversible and will remove the license from the system. - [Create a review](https://freemius.com/help/api/licenses/create-review.md): Create a review associated with a license. If you want to create/import reviews which are not associated with a license or from a different system, please use the Review endpoint under `products/{product_id}/reviews.json`. - [Deactivate installs](https://freemius.com/help/api/licenses/deactivate-installs.md): Deactivate license from all installs. - [Deactivate a license](https://freemius.com/help/api/licenses/deactivate.md): Deactivate a license from an install (No Authorization header is required). - [Generate upgrade link](https://freemius.com/help/api/licenses/generate-upgrade-link.md): Generate an upgrade link for a license. The API accepts a variety of parameters with which you can specify new plans or quota or billing cycles. If you skip all those, then a manual renewal link will be generated instead. The link will be valid for 24 hours. - [Get review URL](https://freemius.com/help/api/licenses/get-review-url.md): Retrieve the review URL associated with a license. - [List all subscriptions](https://freemius.com/help/api/licenses/list-subscriptions.md): Retrieve the subscription collection associated with a license. - [List all licenses](https://freemius.com/help/api/licenses/list.md): Retrieve the license collection associated with a product. - [Resend license keys](https://freemius.com/help/api/licenses/resend-keys.md): Send an email from Freemius with all the license keys associated with the given email address. The email is sent to the email address. - [Resend the upgrade email](https://freemius.com/help/api/licenses/resend-upgrade-email.md): Resend the license upgrade email. - [Retrieve latest subscription](https://freemius.com/help/api/licenses/retrieve-latest-subscription.md): A license can have only **one active subscription** at any given time. However, users may **upgrade**, **downgrade**, or **change their payment method**, which may result in a new subscription being created and associated with the same license. - [Retrieve a license](https://freemius.com/help/api/licenses/retrieve.md): Retrieve a specific license by its ID. - [Send the renewal email](https://freemius.com/help/api/licenses/send-renewal-email.md): Send the manual license renewal email. The system will send emails only for licenses with cancelled or inactive subscriptions. - [Update a license](https://freemius.com/help/api/licenses/update.md): Update a specific license by its ID. For ownership transfer please use the `new_user_id`. Ownership transfer is not supported for SaaS products. #### payments Payments - [Payments](https://freemius.com/help/api/payments.md): Payments - [Download invoice](https://freemius.com/help/api/payments/download-invoice.md): Download invoice of a payment. - [List all payments](https://freemius.com/help/api/payments/list.md): Retrieve the payment collection associated with the product. - [Retrieve a payment](https://freemius.com/help/api/payments/retrieve.md): Retrieve a specific payment. #### plans Plans - [Plans](https://freemius.com/help/api/plans.md): Plans - [Clone pricing to other currency](https://freemius.com/help/api/plans/clone-pricing-other-currency.md): Create new pricing in a specified currency from an existing one. - [Create a license](https://freemius.com/help/api/plans/create-license.md): Create a new license for the plan and pricing. Please note that: - [List all currencies](https://freemius.com/help/api/plans/list-currencies.md): Retrieve all the currencies available for all the plans. - [List all features](https://freemius.com/help/api/plans/list-features.md): Retrieve the features collection of a plan. - [List all plan's pricing](https://freemius.com/help/api/plans/list-s-pricing.md): Retrieve the collection of all the plan's pricings. - [List all plans](https://freemius.com/help/api/plans/list.md): Retrieve the plans collection. - [Retrieve a pricing](https://freemius.com/help/api/plans/retrieve-pricing.md): Retrieve a specific plan pricing by ID. - [Retrieve a plan](https://freemius.com/help/api/plans/retrieve.md): Retrieve a specific plan by ID. #### products Products - [Products](https://freemius.com/help/api/products.md): Products - [Check product status](https://freemius.com/help/api/products/check-status.md): Check if the product is active. - [Delete all email addresses](https://freemius.com/help/api/products/delete-email-addresses.md): Delete all email addresses associated with a product. Sets the product to use the default store-level email addresses. - [Delete a feature](https://freemius.com/help/api/products/delete-feature.md): Delete a product's feature. - [Generate portal login link](https://freemius.com/help/api/products/generate-portal-login-link.md): Generate a direct login link for a user in the context of the store of the product. The login link is valid for 5 minutes from generation. Either user ID or email must be provided. - [Get product info](https://freemius.com/help/api/products/get-info.md): Get product info. Please use the Developer Dashboard to update the information of a product. - [List all addons](https://freemius.com/help/api/products/list-addons.md): Retrieve the addons collection. - [List all email addresses](https://freemius.com/help/api/products/list-email-addresses.md): Retrieve the email addresses collection associated with a product. In case the product is using the store's email address configuration, the endpoint will return a `404` error. - [List all features](https://freemius.com/help/api/products/list-features.md): Retrieve the product features collection. - [Retrieve a feature](https://freemius.com/help/api/products/retrieve-feature.md): Retrieve a product's feature. - [Retrieve the pricing table data](https://freemius.com/help/api/products/retrieve-pricing-table-data.md): Retrieve the plugin's full features & pricing data for a pricing table. Used by our [JS SDK](https://freemius.com/help/documentation/saas-sdk/react-starter/components/#subscription-plans-table), and [WordPress SDK](https://freemius.com/help/documentation/wordpress-sdk/wp-admin-in-dashboard-upgrading/) to create pricing components and pages. - [Retrieve a product](https://freemius.com/help/api/products/retrieve.md): Query and retrieve a specific product by ID. - [Update a feature](https://freemius.com/help/api/products/update-feature.md): Update a product's feature. Please note that the `value` attribute can only be set and updated per plan with a developer scope authorization. - [Update a product](https://freemius.com/help/api/products/update.md): Update a specific product by ID. #### reviews Reviews - [Reviews](https://freemius.com/help/api/reviews.md): Reviews - [Create a review](https://freemius.com/help/api/reviews/create.md): Create a product review. - [Delete a review](https://freemius.com/help/api/reviews/delete.md): Delete a product review by ID. - [List all reviews](https://freemius.com/help/api/reviews/list.md): Retrieve the reviews collection. - [Retrieve reviews summary](https://freemius.com/help/api/reviews/retrieve-summary.md): Retrieve the summary of the reviews collection. Every item is an object with a `rate` and `count` properties, where `rate` is the rating value (0-100) and `count` is the number of reviews with that rating. Reviews are grouped by their rating. - [Retrieve a review](https://freemius.com/help/api/reviews/retrieve.md): Retrieve a product review by ID. - [Update a review](https://freemius.com/help/api/reviews/update.md): Update a product review by ID #### subscriptions Subscriptions - [Subscriptions](https://freemius.com/help/api/subscriptions.md): Subscriptions - [Cancel a subscription](https://freemius.com/help/api/subscriptions/cancel.md): Use this endpoint to **cancel the subscription**. If the subscription is currently in a **trialing state**, this will also cancel the trial. - [Create a new migrated payment](https://freemius.com/help/api/subscriptions/create-new-migrated-payment.md): In case you want to synchronize migrated subscription from the legacy platform use this endpoint to have our system log a migrated payment. Depending on your use case you can also choose to extend the license. Please read our [migration documentation](https://freemius.com/help/documentation/migration/) to learn more. - [List all payments](https://freemius.com/help/api/subscriptions/list-payments.md): Retrieve the payment collection associated with the subscription. - [List all subscriptions](https://freemius.com/help/api/subscriptions/list.md): Retrieve the subscription collecttion associated with your product. - [Retrieve a subscription](https://freemius.com/help/api/subscriptions/retrieve.md): Retrieve a subscription associated with your product. - [Update a subscription](https://freemius.com/help/api/subscriptions/update.md): Update a subscription to activate a cancellation coupon. #### trials Trials - [Trials](https://freemius.com/help/api/trials.md): Trials - [List all trials](https://freemius.com/help/api/trials/list.md): List the trial collection associated with the product. #### users Users - [Users](https://freemius.com/help/api/users.md): Users - [Create a checkout token](https://freemius.com/help/api/users/create-checkout-token.md): Create a 1 min long token that represents the details of the user for setting the user context in a checkout session. Please read our [documentation](https://freemius.com/help/documentation/selling-with-freemius/freemius-checkout-buy-button/#user_token_in_checkout_new) to learn how to use it. - [Create a user](https://freemius.com/help/api/users/create.md): Create a new user associated with the product. - [Download invoice](https://freemius.com/help/api/users/download-invoice.md): Download invoice of a payment of a user. Use this endpoint to securely download the invoice of a payment belonging to a user. This is useful for implementing your own Customer Portal with download links to invoices. - [List all events](https://freemius.com/help/api/users/list-events.md): Retrieve a log of the events for the user associated with the product. Freemius tracks events such as opt-in, license activation, purchase etc. You can use this data for marketing and other automation purposes. More information can be found [here](https://freemius.com/help/documentation/marketing-automation/events-webhooks/). - [List all installs](https://freemius.com/help/api/users/list-installs.md): Retrieve the install collection associated with the user. - [List all licenses](https://freemius.com/help/api/users/list-licenses.md): Retrieve the license collection associated with a user. - [List all payments](https://freemius.com/help/api/users/list-payments.md): Retrieve the payment collection associated with a user. - [List all subscriptions](https://freemius.com/help/api/users/list-subscriptions.md): Retrieve the subscription collection associated with a user. - [List all users](https://freemius.com/help/api/users/list.md): Gets the user collection associated with a product. - [Retrieve billing](https://freemius.com/help/api/users/retrieve-billing.md): Retrieves the billing information of a user for a specific product. - [Retrieve a user](https://freemius.com/help/api/users/retrieve.md): Retrieve a user associated with your product. - [Update or create billing](https://freemius.com/help/api/users/update-or-create-billing.md): Update or create the billing information for a user. - [Update a user](https://freemius.com/help/api/users/update.md): Update a user associated with your product. ### Frequently Asked Questions - [Popular](https://freemius.com/help/faq/all.md): What kind of products can I sell with Freemius? - [Analytics & Insights](https://freemius.com/help/faq/analytics-insights.md): Can I use Insights in my Premium only plugin or theme? - [Emails](https://freemius.com/help/faq/emails.md): How can I send emails to my users and customers? - [Freemius WordPress SDK](https://freemius.com/help/faq/freemius-sdk.md): What languages is your WordPress SDK translated to? - [Licensing](https://freemius.com/help/faq/licensing.md): Can I upsell multi-site licenses? - [My Account](https://freemius.com/help/faq/my-account.md): Are there any additional fees for receiving payments through PayPal? - [SaaS & Apps](https://freemius.com/help/faq/saas-apps.md): What kind of products can I sell with Freemius? - [Sales](https://freemius.com/help/faq/sales.md): What payment methods can I accept with Freemius? - [WordPress](https://freemius.com/help/faq/wordpress.md): Is Freemius a WordPress.org Compliant?