Retrieve the program details

GET 
https://api.freemius.com/v1/products/{product_id}/aff.json

Auth:Bearer TokenSCOPE: PRODUCT

Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.

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

---

Retrieves the product's affiliation program details.

Request

Path Parameters

product_id integer<int64>required
The ID of the product.
Possible values: >= 1
Example: 1234

Query Parameters

type anyrequired
The type of the program to retrieve.
Example: affiliation

Responses

200

The retrieved product affiliate program details.

application/json

Schema

idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

createdstring<date-time>

The date and time the entity was created, under UTC timezone.

Example: 2025-01-01 00:00:00

updatedstring<date-time>nullable

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

is_activeboolean<boolean>

Whether the affiliation program is active and can be used.

typestring<string>

Default value: affiliation

The type of the affiliation program.

Possible values: [affiliation, rewards]

reward_typestring

Default value: payout

The reward type of the affiliation program.

Possible values: [payout, credit]

referral_attributionstring

Default value: first

The attribution type of the referral. For first, the referral will be attributed to the first visited source containing the affiliation link that was clicked.

Possible values: [first, last]

cookie_daysinteger<int64>nullable

Default value: 30

The number of days the referral cookie is valid. 0 for session cookie, and null for non-expiring cookie (until cookies are cleaned).

Possible values: >= 0

Example: 0

commissioninteger<int64>

Default value: 20

The commission amount.

Possible values: >= 0

Example: 20

commission_typestring

Default value: percentage

The commission type of the affiliation program.

Possible values: [percentage, dollar]

commission_renewals_daysinteger<int64>nullable

Default value: 0

The number of days the affiliate will get paid for all renewals after the initial upgrade/purchase. 0 for only the first payment, and null for all renewals. For greater than 0, affiliate will get paid for all renewals x commission_renewals_days days after the initial upgrade/purchase.

Possible values: >= 0

Example: 0

install_commissioninteger<int64>nullable

Default value: null

The commission amount for the initial installation.

Possible values: >= 0

Example: 100

default_urlstring<string>

The default checkout link of the product.

Example: https://checkout.freemius.com/product/12196

reward_customer_typestring

Default value: all

The type of customer to get the referral commission.

Possible values: [new_user, new_customer, all]

future_payments_daysinteger<int64>nullable

Default value: 0

The number of days an affiliate will get paid for all customer payments after the initial payment. 0 for only on directly affiliated links, and null for all customers' lifetime payments.

Possible values: >= 0

Example: 0

is_social_allowedboolean<boolean>

Whether to allow referrals from social sites.

Example: true

is_app_allowedboolean<boolean>

Whether to allow conversions without HTTP referrer header at all.

Example: true

is_any_site_allowedboolean<boolean>

Whether to allow referrals from any site.

Example: true

is_hiddenboolean<boolean>

Default value: false

Whether to show the affiliation program only to users who are already affiliates of the product. If true, the affiliation program will be hidden from users who are not affiliates of the product.

commissions object

The commission rates in all currencies.

property name*number<int>

plugin_affiliate_terms_idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

plugin_idstring<int64>

The ID of the product the entity belongs to.

Possible values: >= 1

Example: 123456

moderationstring

Default value: selected

Refers to who can be an affiliate.

Possible values: [selected, customers, all]

pending_countinteger<int64>

The number of pending affiliate applications that product owners need to review.

Possible values: >= 0

Example: 1234

statusstringnullable

The status of a product user who has applied for the affiliate program.

plugin_titlestring

The title of the product.

Example: My Freemius Plugin

400

Bad request. The request could not be understood by the server due to malformed syntax or arguments.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

401

Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

402

The request is missing the specified argument.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

404

The requested resource was not found.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}