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

We support Bearer authentication. You can get the API Key from the Freemius Developer Dashboard for a product.

  1. Open the Settings page of the relevant product.
  2. Click on the API Token tab.
  3. Copy the API Bearer Authorization Token from the UI.

More information can be found under the Security section of every endpoint.

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

Delete all email addresses

Request

Delete all email addresses associated with a product. Sets the product to use the default store-level email addresses.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
curl -i -X DELETE \
  https://api.freemius.com/v1/products/1234/emails/addresses.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Email addresses deleted. Product set to use the default store-level email addresses.

Response
No content

Retrieve a feature

Request

Retrieve a product's feature. In case of WordPress products, this is used automatically for the in-dashboard pricing page.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
feature_idinteger(int64)>= 1required

The ID of the feature.

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/features/1234.json?fields=id%2Cname%2Cslug' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The product's feature.

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 Plugin.

Example: "1234"
titlestring

The title of the feature.

Example: "Pageviews per month"
descriptionstring

The description of the feature, up to 256 characters. This will be displayed as the description in the tooltip on the pricing page.

Example: "The number of times a page is loaded."
is_featuredboolean

Whether the feature is highlighted and will be shown in the main pricing table. If set as false, the feature will be only shown in the plans' comparison table.

Example: "true"
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "plugin_id": "1234",
  "title": "Pageviews per month",
  "description": "The number of times a page is loaded.",
  "is_featured": "true"
}

Update a feature

Request

Update a product's feature. Please note that the value attribute can only be set and updated per plan with a developer scope authorization.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
feature_idinteger(int64)>= 1required

The ID of the feature.

Example: 1234
Bodyapplication/json
titlestring

The title of the feature.

Example: "Pageviews per month"
descriptionstring

The description of the feature, up to 256 characters. This will be displayed as the description in the tooltip on the pricing page.

Example: "The number of times a page is loaded."
is_featuredboolean

Whether the feature is highlighted and will be shown in the main pricing table. If set as false, the feature will be only shown in the plans' comparison table.

Example: "true"
curl -i -X PUT \
  https://api.freemius.com/v1/products/1234/features/1234.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated feature.

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 Plugin.

Example: "1234"
titlestring

The title of the feature.

Example: "Pageviews per month"
descriptionstring

The description of the feature, up to 256 characters. This will be displayed as the description in the tooltip on the pricing page.

Example: "The number of times a page is loaded."
is_featuredboolean

Whether the feature is highlighted and will be shown in the main pricing table. If set as false, the feature will be only shown in the plans' comparison table.

Example: "true"
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "plugin_id": "1234",
  "title": "Pageviews per month",
  "description": "The number of times a page is loaded.",
  "is_featured": "true"
}

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

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