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

List all addons

Request

Retrieve the addons collection.

Path
product_idinteger(int64)>= 1required

The ID of the product.

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

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

Default false
enrichedboolean

If set to true, returns marketing info.

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

Responses

The list of all the addons.

Bodyapplication/json
addonsArray of objects(Product)
Response
application/json
{
  "addons": [
    { … }
  ]
}

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

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