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

Freemius API supports Bearer Token authentication for product-specific operations.

To retrieve your API token:

  1. Go to the Freemius Developer Dashboard.
  2. Open the Settings page of the relevant product.
  3. Click on the API Token tab.
  4. Copy the API Bearer Authorization Token from the UI.

Use this token by including it in the Authorization header of your API requests:

Authorization: Bearer {api_token}

Bearer tokens are scoped to a specific product. This means they can only be used with endpoints under the /products/{product_id}/ namespace. For example:

GET /products/12345/users.json
Authorization Bearer {api_token}

Requests to endpoints outside the product scope will result in an authorization error.

Other Scopes and Authentication

The Freemius API is organized around different scopes, based on the top-level entity of the operation:

For example, let's say you want to list all payments of a product. This operation can be done in several scopes:

  • Product Scope: /products/{product_id}/payments.json.
  • Developer Scope: /developers/{developer_id}/products/{product_id}/payments.json.

On the other hand, if a user would want to list their payment, then endpoint will be scoped to the user:

  • User Scope: /users/{user_id}/payments.json.

Some operations can be done from a particular scope only. For example only a developer can update a plan of a product or create a new plan. So the following operations will work:

  • Update Plan: POST /developers/{developer_id}/products/{product_id}/plans/{plan_id}.json
  • Create Plan: POST /developers/{developer_id}/products/{product_id}/plans.json

If you try to perform the same operation on a product scope, it will return an error. The scopes provides a way to control access and permissions for different entities in the Freemius ecosystem.

Currently, Bearer Token authentication is supported for product scope only. If you need access to endpoints in others scopes, use the secret-key based authentication with the following SDKs:

For most use cases, managing your products, licenses, and customers through the Developer Dashboard or Customer Portal provides all the necessary capabilities.

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

Retrieve a coupon

Request

Get details of a specific coupon by ID.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

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

Responses

The coupon is retrieved successfully.

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"
entity_idstring(int64)>= 1

The ID of the entity the coupon belongs to.

Example: 12345
entity_typestring

The type of the entity the coupon belongs to.

Enum"plugin""store""marketplace"
Example: "plugin"
plansstring or null

Comma separated IDs of plans the coupon would work for. If null, coupon supports all plans.

Example: "123,654,8757"
licensesstring or null

Comma separated licenses quota limits. If null, coupon supports all license limits. 0 is used for an unlimited-site license.

Example: "1,5,10,0"
billing_cyclesstring or null

Comma separated billing cycles. If null, coupon supports all billing cycles. 0 is used for lifetime billing cycle.

Example: "1,12"
codestring

The coupon code.

Example: "BLACKFRIDAY2024"
discountinteger

The discount amount.

discount_typestring

The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount.

Enum"dollar""percentage"
start_datestring(date-time)

Date and time from when the coupon will be activated.

Example: "2025-04-01 11:13:28"
end_datestring(date-time)

Date and time, after which the coupon will be expired.

Example: "2025-04-30 19:17:21"
redemptionsinteger

The total number of redemptions of this coupon.

redemptions_limitinteger or null

The total number of redemptions limit of this coupon.

has_renewals_discountboolean

Whether the coupon also supports discount for renewals or first payment only.

has_addons_discountboolean

Whether the coupon supports discount for add-ons or not.

is_one_per_userboolean

Whether to limit the coupon usage one per user.

is_activeboolean

Whether the coupon is active. Use this flag to temporarily disable the coupon.

user_typestring

The user type the coupon is applicable to.

Default "all"
Enum"all""new""current""previous""customer""migrated"
sourcenumber

The source of the migration data. To get support migrating from other platform please see our documentation.

  • 0 - Freemius
  • 1 - Other
  • 2 - Easy Digital Downloads (EDD)
  • 3 - WooCommerce (WC)
  • 4 - Rating Widget
  • 5 - Gumroad
  • 6 - CodeCanyon
  • 7 - ThemeForest
  • 8 - AppSumo
  • 9 - SendOwl
  • 10 - WHMCS
  • 11 - Lemon Squeezy
Enum0123456789
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "entity_id": 12345,
  "entity_type": "plugin",
  "plans": "123,654,8757",
  "licenses": "1,5,10,0",
  "billing_cycles": "1,12",
  "code": "BLACKFRIDAY2024",
  "discount": 0,
  "discount_type": "dollar",
  "start_date": "2025-04-01 11:13:28",
  "end_date": "2025-04-30 19:17:21",
  "redemptions": 0,
  "redemptions_limit": 0,
  "has_renewals_discount": true,
  "has_addons_discount": true,
  "is_one_per_user": true,
  "is_active": true,
  "user_type": "all",
  "source": 0
}

Update a coupon

Request

Update a specific coupon's details by ID.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

Example: 1234
Bodyapplication/jsonrequired
plansstring or null

Comma separated IDs of plans the coupon would work for. If null, coupon supports all plans.

Example: "123,654,8757"
licensesstring or null

Comma separated licenses quota limits. If null, coupon supports all license limits. 0 is used for an unlimited-site license.

Example: "1,5,10,0"
billing_cyclesstring or null

Comma separated billing cycles. If null, coupon supports all billing cycles. 0 is used for lifetime billing cycle.

Example: "1,12"
user_typestring

The user type the coupon is applicable to.

Default "all"
Enum"all""new""current""previous""customer""migrated"
codestring

The coupon code.

Example: "BLACKFRIDAY2024"
discountinteger

The discount amount.

discount_typestring

The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount.

Enum"dollar""percentage"
start_datestring(date-time)

Date and time from when the coupon will be activated.

Example: "2025-04-01 11:13:28"
end_datestring(date-time)

Date and time, after which the coupon will be expired.

Example: "2025-04-30 19:17:21"
redemptions_limitinteger or null

The total number of redemptions limit of this coupon.

has_renewals_discountboolean

Whether the coupon also supports discount for renewals or first payment only.

has_addons_discountboolean

Whether the coupon supports discount for add-ons or not.

is_one_per_userboolean

Whether to limit the coupon usage one per user.

is_activeboolean

Whether the coupon is active. Use this flag to temporarily disable the coupon.

curl -i -X PUT \
  https://api.freemius.com/v1/products/1234/coupons/1234.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The coupon is updated.

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"
entity_idstring(int64)>= 1

The ID of the entity the coupon belongs to.

Example: 12345
entity_typestring

The type of the entity the coupon belongs to.

Enum"plugin""store""marketplace"
Example: "plugin"
plansstring or null

Comma separated IDs of plans the coupon would work for. If null, coupon supports all plans.

Example: "123,654,8757"
licensesstring or null

Comma separated licenses quota limits. If null, coupon supports all license limits. 0 is used for an unlimited-site license.

Example: "1,5,10,0"
billing_cyclesstring or null

Comma separated billing cycles. If null, coupon supports all billing cycles. 0 is used for lifetime billing cycle.

Example: "1,12"
codestring

The coupon code.

Example: "BLACKFRIDAY2024"
discountinteger

The discount amount.

discount_typestring

The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount.

Enum"dollar""percentage"
start_datestring(date-time)

Date and time from when the coupon will be activated.

Example: "2025-04-01 11:13:28"
end_datestring(date-time)

Date and time, after which the coupon will be expired.

Example: "2025-04-30 19:17:21"
redemptionsinteger

The total number of redemptions of this coupon.

redemptions_limitinteger or null

The total number of redemptions limit of this coupon.

has_renewals_discountboolean

Whether the coupon also supports discount for renewals or first payment only.

has_addons_discountboolean

Whether the coupon supports discount for add-ons or not.

is_one_per_userboolean

Whether to limit the coupon usage one per user.

is_activeboolean

Whether the coupon is active. Use this flag to temporarily disable the coupon.

user_typestring

The user type the coupon is applicable to.

Default "all"
Enum"all""new""current""previous""customer""migrated"
sourcenumber

The source of the migration data. To get support migrating from other platform please see our documentation.

  • 0 - Freemius
  • 1 - Other
  • 2 - Easy Digital Downloads (EDD)
  • 3 - WooCommerce (WC)
  • 4 - Rating Widget
  • 5 - Gumroad
  • 6 - CodeCanyon
  • 7 - ThemeForest
  • 8 - AppSumo
  • 9 - SendOwl
  • 10 - WHMCS
  • 11 - Lemon Squeezy
Enum0123456789
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "entity_id": 12345,
  "entity_type": "plugin",
  "plans": "123,654,8757",
  "licenses": "1,5,10,0",
  "billing_cycles": "1,12",
  "code": "BLACKFRIDAY2024",
  "discount": 0,
  "discount_type": "dollar",
  "start_date": "2025-04-01 11:13:28",
  "end_date": "2025-04-30 19:17:21",
  "redemptions": 0,
  "redemptions_limit": 0,
  "has_renewals_discount": true,
  "has_addons_discount": true,
  "is_one_per_user": true,
  "is_active": true,
  "user_type": "all",
  "source": 0
}

Delete a coupon

Request

Delete a specific coupon by ID.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

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

Responses

The API has no content to send. This usually happens when some entity is deleted.

Response
No content

List all coupons

Request

Retrieve the coupon collection associated with your product.

Searching and filtering

You can use filtering to search for a particular coupon or a group of coupons. The available parameters are:

  • code - You can explicitly search coupon by the code.
  • search - You can search by coupon code or coupon ID.
  • prefix - You can filter by coupon code prefix.

If using search and filtering, then the is_enriched parameter is ignored.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
Query
codestring

The coupon code filter.

is_enrichedboolean

If true, each coupon will include multi-currency discount properties. Coupons will only be enriched if no filtering is used.

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
prefixstring

Optional coupon code prefix for search coupons.

searchstring

Optional coupon code(or code part) for search coupons.

curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/coupons.json?code=string&count=10&is_enriched=true&offset=10&prefix=string&search=string' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

Provides a collection of coupons associated with the product. All coupons are listed under the coupons key.

Bodyapplication/json
couponsArray of objects
Response
application/json
{
  "coupons": [
    { … }
  ]
}

Create a coupon

Request

Create a new coupon.

Alternatively, you can use the Freemius Developer Dashboard.

If you're creating coupon from your SaaS for some specific use case, please be sure to set the plans, redemptions_limit, end_date, and is_one_per_user properties to the appropriate values, to avoid misuse.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
Bodyapplication/jsonrequired
plansstring or null

Comma separated IDs of plans the coupon would work for. If null, coupon supports all plans.

Example: "123,654,8757"
licensesstring or null

Comma separated licenses quota limits. If null, coupon supports all license limits. 0 is used for an unlimited-site license.

Example: "1,5,10,0"
billing_cyclesstring or null

Comma separated billing cycles. If null, coupon supports all billing cycles. 0 is used for lifetime billing cycle.

Example: "1,12"
user_typestring

The user type the coupon is applicable to.

Default "all"
Enum"all""new""current""previous""customer""migrated"
codestring

The coupon code.

Example: "BLACKFRIDAY2024"
discountinteger

The discount amount.

discount_typestring

The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount.

Enum"dollar""percentage"
start_datestring(date-time)

Date and time from when the coupon will be activated.

Example: "2025-04-01 11:13:28"
end_datestring(date-time)

Date and time, after which the coupon will be expired.

Example: "2025-04-30 19:17:21"
redemptions_limitinteger or null

The total number of redemptions limit of this coupon.

has_renewals_discountboolean

Whether the coupon also supports discount for renewals or first payment only.

has_addons_discountboolean

Whether the coupon supports discount for add-ons or not.

is_one_per_userboolean

Whether to limit the coupon usage one per user.

is_activeboolean

Whether the coupon is active. Use this flag to temporarily disable the coupon.

curl -i -X POST \
  https://api.freemius.com/v1/products/1234/coupons.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The coupon is created.

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"
entity_idstring(int64)>= 1

The ID of the entity the coupon belongs to.

Example: 12345
entity_typestring

The type of the entity the coupon belongs to.

Enum"plugin""store""marketplace"
Example: "plugin"
plansstring or null

Comma separated IDs of plans the coupon would work for. If null, coupon supports all plans.

Example: "123,654,8757"
licensesstring or null

Comma separated licenses quota limits. If null, coupon supports all license limits. 0 is used for an unlimited-site license.

Example: "1,5,10,0"
billing_cyclesstring or null

Comma separated billing cycles. If null, coupon supports all billing cycles. 0 is used for lifetime billing cycle.

Example: "1,12"
codestring

The coupon code.

Example: "BLACKFRIDAY2024"
discountinteger

The discount amount.

discount_typestring

The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount.

Enum"dollar""percentage"
start_datestring(date-time)

Date and time from when the coupon will be activated.

Example: "2025-04-01 11:13:28"
end_datestring(date-time)

Date and time, after which the coupon will be expired.

Example: "2025-04-30 19:17:21"
redemptionsinteger

The total number of redemptions of this coupon.

redemptions_limitinteger or null

The total number of redemptions limit of this coupon.

has_renewals_discountboolean

Whether the coupon also supports discount for renewals or first payment only.

has_addons_discountboolean

Whether the coupon supports discount for add-ons or not.

is_one_per_userboolean

Whether to limit the coupon usage one per user.

is_activeboolean

Whether the coupon is active. Use this flag to temporarily disable the coupon.

user_typestring

The user type the coupon is applicable to.

Default "all"
Enum"all""new""current""previous""customer""migrated"
sourcenumber

The source of the migration data. To get support migrating from other platform please see our documentation.

  • 0 - Freemius
  • 1 - Other
  • 2 - Easy Digital Downloads (EDD)
  • 3 - WooCommerce (WC)
  • 4 - Rating Widget
  • 5 - Gumroad
  • 6 - CodeCanyon
  • 7 - ThemeForest
  • 8 - AppSumo
  • 9 - SendOwl
  • 10 - WHMCS
  • 11 - Lemon Squeezy
Enum0123456789
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "entity_id": 12345,
  "entity_type": "plugin",
  "plans": "123,654,8757",
  "licenses": "1,5,10,0",
  "billing_cycles": "1,12",
  "code": "BLACKFRIDAY2024",
  "discount": 0,
  "discount_type": "dollar",
  "start_date": "2025-04-01 11:13:28",
  "end_date": "2025-04-30 19:17:21",
  "redemptions": 0,
  "redemptions_limit": 0,
  "has_renewals_discount": true,
  "has_addons_discount": true,
  "is_one_per_user": true,
  "is_active": true,
  "user_type": "all",
  "source": 0
}

Retrieve a note

Request

Get the details of a note associated with a coupon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

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

Responses

The coupon note details.

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"
scope_entity_idinteger

The ID of the scope entity that this note is associated with.

Example: 12345
scope_entity_typestring

The type of the scope entity that this note is associated with.

Enum"plugin""store"
entity_idinteger

The ID of the entity that this note is associated with.

Example: 12345
entity_typestring

The type of the entity that this note is associated with.

Enum"coupon""user""payment""subscription""license"
notestring

The note.

Example: "This is a note"
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "scope_entity_id": 12345,
  "scope_entity_type": "plugin",
  "entity_id": 12345,
  "entity_type": "coupon",
  "note": "This is a note"
}

Update a note

Request

Update a note for a coupon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

Example: 1234
Bodyapplication/json
notestring
Example: "This is an updated note."
curl -i -X PUT \
  https://api.freemius.com/v1/products/1234/coupons/1234/note.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The coupon note was updated.

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"
scope_entity_idinteger

The ID of the scope entity that this note is associated with.

Example: 12345
scope_entity_typestring

The type of the scope entity that this note is associated with.

Enum"plugin""store"
entity_idinteger

The ID of the entity that this note is associated with.

Example: 12345
entity_typestring

The type of the entity that this note is associated with.

Enum"coupon""user""payment""subscription""license"
notestring

The note.

Example: "This is a note"
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "scope_entity_id": 12345,
  "scope_entity_type": "plugin",
  "entity_id": 12345,
  "entity_type": "coupon",
  "note": "This is a note"
}

Create a note

Request

Create a new note for a coupon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

Example: 1234
Bodyapplication/json
notestring
Example: "This is a note."
curl -i -X POST \
  https://api.freemius.com/v1/products/1234/coupons/1234/note.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The note was added to the coupon.

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"
scope_entity_idinteger

The ID of the scope entity that this note is associated with.

Example: 12345
scope_entity_typestring

The type of the scope entity that this note is associated with.

Enum"plugin""store"
entity_idinteger

The ID of the entity that this note is associated with.

Example: 12345
entity_typestring

The type of the entity that this note is associated with.

Enum"coupon""user""payment""subscription""license"
notestring

The note.

Example: "This is a note"
Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "scope_entity_id": 12345,
  "scope_entity_type": "plugin",
  "entity_id": 12345,
  "entity_type": "coupon",
  "note": "This is a note"
}

Delete a note

Request

Delete a note for a coupon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

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

Responses

The API has no content to send. This usually happens when some entity is deleted.

Response
No content

Retrieve special coupons

Request

Get the details of a special coupon. *

Searching and filtering

You can use filtering to search for a particular coupon or a group of coupons by type.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
Query
typestring

Filter based on a coupon type.

Enum"affiliate""renewals_discount""manual_renewals_discount""subscription_cancellation""cart_recovery""exit_intent"
curl -i -X GET \
  'https://api.freemius.com/v1/products/1234/coupons/special.json?type=affiliate' \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The special coupons details.

Bodyapplication/json
coupon_entitiesArray of objects(CouponEntityEnriched)
Response
application/json
{
  "coupon_entities": [
    { … }
  ]
}

Create a special coupon

Request

Create a special coupon.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

Example: 1234
special_idstringrequired

The ID of the special coupon.

Enum"affiliate""cart_recovery""subscription_cancellation""exit_intent""renewals_discount""manual_renewals_discount"
Example: cart_recovery
curl -i -X PUT \
  https://api.freemius.com/v1/products/1234/coupons/1234/special/cart_recovery.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The special coupon has been created.

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"
coupon_idnumber

The ID of the coupon.

Example: 12345
entity_idstring(int64)>= 1

The ID of the entity.

Example: 12345
entity_typeinteger

The type of the entity (Usually 2 which means it is a product or 20 which means it is an affiliate).

Example: 2
typestring

The special coupon type.

Enum"affiliate""renewals_discount""manual_renewals_discount""subscription_cancellation""cart_recovery""exit_intent"
codestring

The coupon code.

Example: "BLACKFRIDAY2024"
redemptionsinteger

The total number of redemptions of this coupon.

discountinteger

The discount amount.

discount_typestring

The type of the discount. "percentage" means the discount is a percentage of the price, "dollar" means the discount is a fixed amount.

Enum"dollar""percentage"
discountsobject

If the discount type is dollar, then this field will hold values of absolute discount amount per supported currency.

has_renewals_discountboolean

Whether the coupon also supports discount for renewals or first payment only.

Response
application/json
{
  "id": "123456",
  "created": "2025-01-01 00:00:00",
  "updated": "2025-01-01 00:00:00",
  "coupon_id": 12345,
  "entity_id": 12345,
  "entity_type": 2,
  "type": "affiliate",
  "code": "BLACKFRIDAY2024",
  "redemptions": 0,
  "discount": 0,
  "discount_type": "dollar",
  "discounts": {
    "usd": 10.5,
    "eur": 10.5,
    "gbp": 10.5
  },
  "has_renewals_discount": true
}

Delete a special coupon

Request

Delete a special coupon by ID.

Path
product_idinteger(int64)>= 1required

The ID of the product.

Example: 1234
coupon_idinteger(int64)>= 1required

The ID of the coupon.

Example: 1234
special_idstringrequired

The ID of the special coupon.

Enum"affiliate""cart_recovery""subscription_cancellation""exit_intent""renewals_discount""manual_renewals_discount"
Example: cart_recovery
curl -i -X DELETE \
  https://api.freemius.com/v1/products/1234/coupons/1234/special/cart_recovery.json \
  -H 'Authorization: Bearer <YOUR_AccessToken_HERE>'

Responses

The API has no content to send. This usually happens when some entity is deleted.

Response
No content

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