Freemius API (1.0)

Welcome to the Freemius API Documentation!

You can use our API to access Freemius API endpoints, which can get information on various aspects of Freemius.

  • Manage products.
  • Manage license verifications.
  • Create custom integration with your SaaS.

If you're using Freemius for a WordPress product, please check out our official SDK.

Browse Tutorials and Guides.

Bearer Token Auth

Freemius API supports Bearer Token authentication for product-specific operations.

To retrieve your API token:

  1. Go to the Freemius Developer Dashboard.
  2. Open the Settings page of the relevant product.
  3. Click on the API Token tab.
  4. Copy the API Bearer Authorization Token from the UI.

Use this token by including it in the Authorization header of your API requests:

Authorization: Bearer {api_token}

Bearer tokens are scoped to a specific product. This means they can only be used with endpoints under the /products/{product_id}/ namespace. For example:

GET /products/12345/users.json
Authorization Bearer {api_token}

Requests to endpoints outside the product scope will result in an authorization error.

Other Scopes and Authentication

The Freemius API is organized around different scopes, based on the top-level entity of the operation:

For example, let's say you want to list all payments of a product. This operation can be done in several scopes:

  • Product Scope: /products/{product_id}/payments.json.
  • Developer Scope: /developers/{developer_id}/products/{product_id}/payments.json.

On the other hand, if a user would want to list their payment, then endpoint will be scoped to the user:

  • User Scope: /users/{user_id}/payments.json.

Some operations can be done from a particular scope only. For example only a developer can update a plan of a product or create a new plan. So the following operations will work:

  • Update Plan: POST /developers/{developer_id}/products/{product_id}/plans/{plan_id}.json
  • Create Plan: POST /developers/{developer_id}/products/{product_id}/plans.json

If you try to perform the same operation on a product scope, it will return an error. The scopes provides a way to control access and permissions for different entities in the Freemius ecosystem.

Currently, Bearer Token authentication is supported for product scope only. If you need access to endpoints in others scopes, use the secret-key based authentication with the following SDKs:

For most use cases, managing your products, licenses, and customers through the Developer Dashboard or Customer Portal provides all the necessary capabilities.

Download OpenAPI description
openapi.yaml
Overview
URL

https://freemius.com

Freemius Support

support@freemius.com

License

Proprietary

Terms of Service

Languages
Servers
Production API

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

Mock server

https://docs.freemius.com/_mock/api/

Products

All operations which can be done on a product.

Operations

Subscriptions

All operations associated to a subscription.

Operations

Users

All operations which can be done on a user belonging to a store or a product.

Operations

Licenses

All operations which can be done on a license belonging to a store or a product.

Operations

Coupons

All operations which can be done on a coupon belonging to a store or a product.

Operations

Carts

All operations which can be done on a cart belonging to a store or a product.

Operations

Payments

All operations associated to a payment.

Operations

Installations

Operations related to the installation of a product.

Operations

Retrieve uninstall details

Request

Retrieve the details of an install where the product has been uninstalled.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
install_idinteger(int64)>= 1required

The ID of the install.

Example: 1234
Query
fieldsstring

Comma separated list of fields to return in the response. If not specified, all fields are returned.

Example: fields=id,name,slug
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/installs/1234/uninstall.json?fields=id%2Cname%2Cslug' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The uninstall details.

Bodyapplication/json
idstring(int64)>= 1

The unique identifier of the entity.

Example: "123456"
createdstring(date-time)

The date and time the entity was created, under UTC timezone.

Example: "2025-01-01 00:00:00"
updatedstring or null(date-time)

The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.

Example: "2025-01-01 00:00:00"
plugin_idstring(int64)>= 1

The ID of the product the entity belongs to.

Example: "123456"
install_idstring(int64)>= 1

The ID of the installation or site the entity is associated with.

Example: "123456"
site_idstring(int64)>= 1

The ID of the site.

Example: "1234"
reason_idinteger

Uninstall reason. Possible values:

  • 1 - No longer needed
  • 2 - Found a better alternative
  • 3 - Only needed for short period
  • 4 - Broke the website
  • 5 - Suddenly stopped working
  • 6 - Cannot continue paying
  • 7 - Other
  • 8 - Didn't work after installation
  • 9 - User doesn't like to share data
  • 10 - Didn't understand how it works
  • 11 - Missing specific feature
  • 12 - Didn't work
  • 13 - Expected something else
  • 14 - Expected to work differently
  • 15 - Temporary deactivation
Enum12345678910
Example: 1
reason_infostring

Additional information gathered from the user for the uninstallation. This is populated when the product user chooses “Other” in contrast to pre-set options.

reasonstring

The reason for the uninstall which translates to the string value of the uninstall reason_id.

Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "plugin_id": "123456",
  "install_id": "123456",
  "site_id": "1234",
  "reason_id": 1,
  "reason_info": "string",
  "reason": "string"
}

List all updates

Request

Retrieve the product update collection available for an install.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
install_idinteger(int64)>= 1required

The ID of the install.

Example: 1234
Query
versionstringrequired

The product's version of the current install. The endpoint will return newer versions when set. This is a required param unless older_than is provided.

Example: version=1.0.0
older_thanstring

If provided, only versions that are older than this will be returned.

Example: older_than=1.0.0
typestring

The product type. If the type provide is all, the latest released or pending version will be returned, whichever has the higher version.

Default "released"
Enum"released""pending""beta""all"
countinteger[ 1 .. 50 ]

The number of records to return.

Default 25
Example: count=10
offsetinteger>= 0

The number of records to skip before starting to return records. Default is 0.

Default 0
Example: offset=10
fieldsstring

Comma separated list of fields to return in the response. If not specified, all fields are returned.

Example: fields=id,name,slug
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/installs/1234/updates.json?count=10&fields=id%2Cname%2Cslug&offset=10&older_than=1.0.0&type=released&version=1.0.0' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Updates collection.

Bodyapplication/json
tagsArray of objects(ProductTag)
Response
application/json
{
  "tags": [
    { … }
  ]
}

Retrieve the latest update

Request

Retrieve the latest product update available for an install.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
install_idinteger(int64)>= 1required

The ID of the install.

Example: 1234
Query
is_premiumboolean

If set, tries to fetch the requested version. If requires premium but no license, will throw an error. Otherwise, fetch version based on license.

readmeboolean

If set, tries to fetch the readme information.

newer_thanboolean

If set, return the latest version's data only if it's newer than this property's value.

typestring

The product type. If the type provided is all, the latest released, beta, or pending version will be returned, whichever has the higher version.

Default "released"
Enum"released""pending""beta""all"
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/installs/1234/updates/latest.json?is_premium=true&newer_than=true&readme=true&type=released' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Updates collection.

Bodyapplication/json
idstring(int64)>= 1

The unique identifier of the entity.

Example: "123456"
createdstring(date-time)

The date and time the entity was created, under UTC timezone.

Example: "2025-01-01 00:00:00"
updatedstring or null(date-time)

The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.

Example: "2025-01-01 00:00:00"
plugin_idstring(int64)>= 1

The ID of the product the entity belongs to.

Example: "123456"
developer_idstring(int64)>= 1

The ID of a developer.

Example: "1234"
slugstring or null

The slug of the product. This is auto-generated from your product settings.

Example: "my-freemius-plugin"
premium_slugstring or null

The slug of the premium product. This is auto-generated from your product's settings.

Example: "my-freemius-plugin-pro"
versionstring(semver)

The version of the product. For WordPress.org products (plugins and themes), we recommend using semver semantics to support composer integration.

Example: "1.0.0"
sdk_versionstring

The Freemius SDK version. Only relevant for WordPress products using the Freemius WP SDK.

Example: "1.2.2"
requires_platform_versionstring or null

The platform version required (e.g WordPress version).

Example: "1.0.0"
requires_programming_language_versionstring or null

The programming language version (e.g PHP version).

Example: "5.6"
tested_up_to_versionstring or null

The tested platform version that the product is compatible (e.g WordPress version).

Example: "1.0.0"
downloadedinteger>= 0

The number of times the product has been downloaded.

Example: "1234"
has_freeboolean

If the product has a free version.

has_premiumboolean

If the product has a premium version.

release_modestring

The release mode of the product.

Enum"released""pending""beta"
limitinteger>= 1

The maximum number of downloads allowed for this version. This is used for staged rollout of WordPress products. Unlimited number is set as null.

Example: 50
uniquesinteger>= 1

The number of unique users that have downloaded the product.

Example: "1234"
is_incrementalboolean

Determines whether the version is incremental or not.

Example: true
is_releasedboolean

A flag that controls the visibility of add-ons in the in-dashboard add-ons marketplace. Defaults to true. Only applicable if the product is an add-on.

urlstring

The Installation zip file URL with authorization token.

Example: "https://example.com/"
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "plugin_id": "123456",
  "developer_id": "1234",
  "slug": "my-freemius-plugin",
  "premium_slug": "my-freemius-plugin-pro",
  "version": "1.0.0",
  "sdk_version": "1.2.2",
  "requires_platform_version": "1.0.0",
  "requires_programming_language_version": "5.6",
  "tested_up_to_version": "1.0.0",
  "downloaded": "1234",
  "has_free": true,
  "has_premium": true,
  "release_mode": "released",
  "limit": 50,
  "uniques": "1234",
  "is_incremental": true,
  "is_released": true,
  "url": "https://example.com/"
}

Trials

Operations related to a trial license of a product.

Operations

Addons

Operations related to an addon of a product.

Operations

Plans

Operations related to plans, pricings and features of a product.

Operations

Deployments

Operations related to version deployments and retrieval.

Operations