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

List all trials

Request

List the trial collection associated with the product.

To support trials, configure your product to offer trial and then users can use the Freemius Checkout to start a trial.

You will need to pass trial=paid or trial=free to the Checkout's paramters to start a trial.

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
offsetinteger>= 0

The number of records to skip before starting to return records. Default is 0.

Default 0
Example: offset=10
countinteger[ 1 .. 50 ]

The number of records to return.

Default 25
Example: count=10
fromstring(date-time)

The start of the date range in YYYY-MM-DD HH:MM:SS format

Example: from=2025-08-01 00:00:00
tostring(date-time)

The end of the date range in YYYY-MM-DD HH:MM:SS format

Example: to=2025-08-01 00:00:00
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/trials.json?count=10&fields=id%2Cname%2Cslug&from=2025-08-01%2000%3A00%3A00&offset=10&to=2025-08-01%2000%3A00%3A00' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Trial collection.

Bodyapplication/json
trialsArray of objects(Trial)
Response
application/json
{
  "trials": [
    { … }
  ]
}

Addons

Operations related to an addon of a product.

Operations

Plans

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

Operations