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.
Freemius allows to migrate your users from other platforms. To do so, you need to set the is_migration parameter to true. This will prevent any emails from being sent to the users and will not log any events.
Once migrated the user can use their existing licenses to activate your product.
A note about the user. Only visible to the developer.
is_marketing_allowedbooleannullable
Whether or not the user has given their consent for marketing materials. A null value indicates that the user has not made a decision yet.
is_betaboolean
Whether or not the user has opted-in to beta versions. We do not recommend using this option anymore since it will opt-in the user to all sites/activations. Currently, sites or activations can be managed individually.
The type of authentication. If app2fa is set, the person has signed for 2FA authentication.
Possible values: [app2fa, password]
secret_keystring
The secret key associated with the entity for authorization.
Example: sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
public_keystring
The public key associated with the entity for authorization.
Example: pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
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
grossnumber<float>
The total amount of money the user has spent on the platform.
last_login_atstring<date-time>nullable
Date and time of the last login.
Example: 2025-07-30 05:56:29
email_statusstring
The status of the last email sent to the user.
Possible values: [delivered, bounce, dropped]
Bad request. The request could not be understood by the server due to malformed syntax or arguments.
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"}
Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.
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"}
The request is missing the specified argument.
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"}
We use essential cookies to enable our site to function. With your consent, we also use analytics and advertising cookies to understand how visitors interact with our site and to improve our services.
