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.

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

List all email addresses

Request

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.

Path
product_idinteger(int64)>= 1required

The ID of the product.

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

Responses

The list of all the email addresses associated with a product.

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"
store_idobject

The ID of the store.

Example: "1234"
generalstring or null

The general system email address.

Example: "foo@example.com"
general_namestring or null

The label to the general system email address.

Example: "Company Support"
dont_replystring or null

The do-not-reply email address.

Example: "donotreply@example.com"
dont_reply_namestring or null

The label to the do-not-reply email address.

Example: "Do Not Reply"
personalstring or null

The personal assistance email address.

Example: "personalmanager@example.com"
personal_namestring or null

The label to the personal assistance email address.

Example: "John Doe"
personal_technicalstring or null

The technical support representative email address.

Example: "techsupport@example.com"
personal_technical_namestring or null

The label to the technical support representative email address.

Example: "Tech Support"
personal_setupstring or null

The happiness representative email address.

Example: "support@example.com"
personal_setup_namestring or null

The label to the happiness representative email address.

Example: "Support"
supportstring or null

The general support email address.

Example: "support@example.com"
support_namestring or null

The label to the general support email address.

Example: "Support"
Response
application/json
{ "id": "123456", "created": "2025-01-01 00:00:00", "updated": "2025-01-01 00:00:00", "plugin_id": "123456", "store_id": "1234", "general": "foo@example.com", "general_name": "Company Support", "dont_reply": "donotreply@example.com", "dont_reply_name": "Do Not Reply", "personal": "personalmanager@example.com", "personal_name": "John Doe", "personal_technical": "techsupport@example.com", "personal_technical_name": "Tech Support", "personal_setup": "support@example.com", "personal_setup_name": "Support", "support": "support@example.com", "support_name": "Support" }

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" }

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