Skip to content

skpassegna/freemius-api-docs

Repository files navigation

Freemius API Documentation

Welcome to the Freemius API documentation! This comprehensive guide will help you integrate and interact with the Freemius API.

Introduction

The Freemius API allows you to:

  • Manage products
  • Handle license verifications
  • Create custom integrations with your SaaS

Authentication

The API uses Bearer authentication. You can obtain your API Key from the Freemius Developer Dashboard for a product or a store.

API Base URL

Production API: https://api.freemius.com/v1

Documentation Structure

  1. Getting Started

    • Introduction and Overview
    • Requirements
    • Quick Start Guide
  2. Authentication

    • Bearer Authentication
    • Security Best Practices
  3. Core Concepts

    • Products
    • Licensing
    • Users and Installations
  4. Products

    • Product Management
    • Settings
    • Version Control
  5. Licensing

    • License Management
    • Activation/Deactivation
  6. Installations

    • Installation Management
    • Updates
    • Clone Handling
  7. Users

    • User Management
    • User Operations
  8. Payments

    • Payment Processing
    • Transaction Management
  9. Subscriptions

    • Subscription Management
    • Subscription Lifecycle
  10. Carts

    • Cart Management
    • Checkout Process
  11. Coupons

    • Coupon Management
    • Discount Handling
  12. Trials

    • Trial Management
    • Trial System
  13. Webhooks

    • Event System
    • Event Types
  14. Advanced Topics

    • Best Practices
    • Error Handling

OpenAPI Specification

For more details, you can refer to the Freemius API OpenAPI Specification.

Terms of Service

For detailed terms of service, please visit: https://freemius.com/terms/

Support

For support inquiries: