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

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

List all payments

Request

Retrieve the payment associated with the install.

This lists all payments collected from the license activated on this 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
extendedboolean

If true, loads linked user email, install URL, subscription billing cycle and plan name.

Default false
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/payments.json?count=10&extended=false&fields=id%2Cname%2Cslug&offset=10' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Payments collection

Bodyapplication/json
paymentsArray of objects
Response
application/json
{
  "payments": [
    { … }
  ]
}

Update permissions

Request

Update permissions to a product install.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
install_idinteger(int64)>= 1required

The ID of the install.

Example: 1234
Bodyapplication/jsonrequired
is_enabledboolean

Whether to enable the selected permission.

permissionsstring(csv)

Comma separated list of permissions to update. Allowed values are site, user, extensions.

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

Responses

Install permission updated.

Bodyapplication/json
permissionsobject
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"
install_idstring(int64)>= 1

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

Example: "123456"
Response
application/json
{
  "permissions": {
    "site": true,
    "user": true,
    "extensions": true
  },
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "install_id": "123456"
}

Retrieve a plan

Request

Retrieve the product plan details to which the install is subscribed.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
install_idinteger(int64)>= 1required

The ID of the install.

Example: 1234
plan_idinteger(int64)>= 1required

The ID of the plan.

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

Responses

Install Plan

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"
namestring(slug)

The name of the plan. Only lowercase characters allowed.

Example: "professional"
titlestring

The title of the plan. This is the human readable name of the plan. Please do not add the suffix Plan to the title, as Freemius does that for you at various places.

Example: "Professional"
descriptionstring or null

The description of the plan.

Example: "For small to medium businesses."
is_free_localhostboolean

Whether the plan offers unlimited local or staging activations with the same license.

Default true
is_block_featuresboolean

Whether to block features on expiration of annual licenses. If false, does not block features but only block updates and support.

Default true
is_block_features_monthlyboolean

Whether to block particular features on expiration of monthly licenses. If false, does not block features but only block updates and support.

Default true
license_typeinteger

The type of the license. 0 for per domain license. 1 for per subdomain license.

Default 0
Enum01
trial_periodinteger or null>= 1

The number of days a trial period will last. If null the plan does not support trials.

Example: "14"
is_require_subscriptionboolean

Whether to require a subscription payment for the trial period.

support_kbstring or null

The Knowledge Base URL.

Example: "https://example.com/help/documentation"
support_forumstring or null

The support Forum URL.

Example: "https://example.com/support"
support_emailstring or null

The support email address.

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

The support phone contact.

Example: "555-555-5555"
support_skypestring or null

The support Skype username.

Example: "skype_username"
is_success_managerboolean

Is a personal success manager allocated with the plan.

is_featuredboolean

Whether this is a featured plan.

is_hiddenboolean

Whether to hide the plan from the auto-generated pricing page. Mostly relevant for WordPress products and our WordPress SDK. Please see our pricing-page library to implement your own.

Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "plugin_id": "123456",
  "name": "professional",
  "title": "Professional",
  "description": "For small to medium businesses.",
  "is_free_localhost": true,
  "is_block_features": true,
  "is_block_features_monthly": true,
  "license_type": 0,
  "trial_period": "14",
  "is_require_subscription": true,
  "support_kb": "https://example.com/help/documentation",
  "support_forum": "https://example.com/support",
  "support_email": "support@example.com",
  "support_phone": "555-555-5555",
  "support_skype": "skype_username",
  "is_success_manager": true,
  "is_featured": true,
  "is_hidden": true
}

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