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

Request

Retrieve the active licenses (usually only one) on an install.

Use this endpoint only when the ID of the license is unknown.

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_enrichedboolean

If true, the parent license's and plan's info will be included in the result if there's any.

Default false
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/installs/1234/licenses.json?is_enriched=false' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Active license.

Bodyapplication/json
licensesArray of objects(License)
Response
application/json
{
  "licenses": [
    { … }
  ]
}

List all market items

Request

Retrieves all market items associated with an Install entity.

Market items are other products (not necessarily powered by Freemius) that are installed in the same site as the Freemius powered product.

It is only after the user chooses to opt-in that such data is collected and sent to Freemius. Right now we only support WordPress products i.e. plugins and themes.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
install_idinteger(int64)>= 1required

The ID of the install.

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

Responses

All market items associated with the install.

Bodyapplication/json
market_itemsArray of objects
Response
application/json
{
  "market_items": [
    { … }
  ]
}

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": [
    { … }
  ]
}

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