List all payments

GET 
https://api.freemius.com/v1/products/{product_id}/affiliate_payments.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.

---

Retrieve the payment collection associated with the product affiliate program.

Request

Path Parameters

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

Query Parameters

count integer
Default value: 25
The number of records to return.
Possible values: >= 1 and <= 50
Example: 10
offset integer
Default value: 0
The number of records to skip before starting to return records. Default is 0.
Possible values: >= 0
Example: 10
status string
Filter affiliate payments by status.
Possible values: [paid, pending, rejected, unpaid]
Example: paid

Responses

200

The collection of affiliate payments associated with the product affiliate program. All payments are listed under the referrals key.

application/json

Schema

referrals object[]

Array [

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

user_idstring<int64>

The ID of the user the entity belongs to.

Possible values: >= 1

Example: 123456

referred_user_idstring<int64>

The ID of the user the entity belongs to.

Possible values: >= 1

Example: 123456

affiliate_idstring<int64>

The ID of the user the entity belongs to.

Possible values: >= 1

Example: 123456

affiliate_visit_idstring<int64>nullable

The ID of the associated affiliate visit. This value is null when the payment is attributed through an affiliate coupon rather than a tracked visit.

Possible values: >= 1

Example: 12345

install_idstring<int64>nullable

The ID of the installation or site the entity is associated with, a null value means it has not been associated with an installation yet.

Possible values: >= 1

Example: 123456

plugin_idstring<int64>

The ID of the product the entity belongs to.

Possible values: >= 1

Example: 123456

payment_idstring<int64>nullable

The ID of the payment associated to the entity.

Possible values: >= 1

Example: 123456

commissioninteger

The earnings attributed to an affiliate for a qualifying purchase or payment.

Example: 12

statusstring

Default value: pending

The status of the payment.

Possible values: [pending, rejected, paid, unpaid]

currencystring

3-char currency code.

Possible values: >= 3 characters and <= 3 characters, [usd, eur, gbp]

visited_atstring<date-time>

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

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

grossnumber<float>

The associated payment amount (not including taxes).

Example: 2075.45

plan_titlestring

The title of the associated plan.

Example: Basic Plan

environmentnumber

The environment the entity belongs to. 0 means it belongs to the production environment, 1 means it belongs to the sandbox environment.

Possible values: [1, 0]

Example: 0

billing_cyclenumber

The billing cycle of the subscription in number of months. 1 means monthly, 12 means annually, 0 means lifetime usually when subscriptions are created for lifetime trials.

Possible values: [1, 12, 0]

firststring

The first name of the associated affiliate.

Example: John

laststring

The last name of the associated affiliate.

Example: Doe

]

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