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

Trials

Operations related to a trial license of a product.

Operations

Addons

Operations related to an addon of a product.

Operations

List all plan's features

Request

Retrieve the plan's features collection for the addon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
addon_idinteger(int64)>= 1required

The ID of the Addon.

Example: 1234
plan_idinteger(int64)>= 1required

The ID of the plan.

Example: 1234
Query
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/addons/1234/plans/1234/features.json?count=10&fields=id%2Cname%2Cslug&offset=10' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

List of all the plan's features for the addon.

Bodyapplication/json
featuresArray of objects(Feature)
Response
application/json
{
  "features": [
    { … }
  ]
}

List all plans

Request

Retrieve the plans collection for the addon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
addon_idinteger(int64)>= 1required

The ID of the Addon.

Example: 1234
Query
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
show_pendingboolean

If set to true, retrieves unreleased add-ons as well.

Default false
typeany

Whether to show released addons only or the hidden as well.

Default "all"
Enum"all""visible"
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/addons/1234/plans.json?count=10&fields=id%2Cname%2Cslug&offset=10&show_pending=false&type=all' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The list of all the plans for the addon.

Bodyapplication/json
plansArray of objects(Plan)
Response
application/json
{
  "plans": [
    { … }
  ]
}

List all pricings

Request

Retrieve the pricing collection for the addon for specific the plan.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
addon_idinteger(int64)>= 1required

The ID of the Addon.

Example: 1234
plan_idinteger(int64)>= 1required

The ID of the plan.

Example: 1234
Query
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
currencystring= 3 characters

3-char currency code.

Enum"usd""eur""gbp"
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/addons/1234/plans/1234/pricing.json?count=10&currency=usd&fields=id%2Cname%2Cslug&offset=10' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The list of all the plans for the addon.

Bodyapplication/json
plansArray of objects(Pricing)
Response
application/json
{
  "plans": [
    { … }
  ]
}

Plans

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

Operations