Skip to content

List affiliate reward entries

GET
/affiliates/rewards
curl --request GET \
--url https://api.proxyrequest.com/api/v1/affiliates/rewards \
--header 'Authorization: Bearer <token>'

Returns individual reward entries generated by customers attributed to the authenticated marketer.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

The operation completed successfully.

Media typeapplication/json
object
count
required
integer
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
Array<object>
object
id
string
<= 36 characters
email
required
string
status

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package’s data or proxies. * pending - Pending * paid - Paid * review - Review * cancelled - Cancelled

string
Allowed values: pending paid review cancelled
package
required
object
id
string
<= 36 characters
name
required

Unique display name for this package shown to customers and in the admin. Residential Starter Business Pro

string
>= 2 characters <= 255 characters
alias
required

Lowercase alphanumeric identifier used internally for package resolution and proxy username routing. Cannot be changed without affecting active connections. residential01 bizpro

string
>= 2 characters <= 255 characters /^[a-z0-9]+$/
is_unlimited_data
Unlimited Data

When enabled, users on this package have no data cap. The proxy will not enforce any bandwidth limit.

boolean
targeting_options
required
object
package
required
string
split_char
required
string
value_char
required
string
continent
required
string
country
required
string
region
required
string
city
required
string
asn
required
string
isp
required
string
username
required
string
pool
required
string
location
required
string
location_format
required
string
session
required
string
session_mode_tag
required
string
session_ttl
required
string
session_ttl_format
required
integer
os
required
string
os_combined
required
boolean
os_split_char
required
string
os_linux
required
string
os_windows
required
string
os_ios
required
string
os_macos
required
string
os_android
required
string
price_total
required
integer
data
Data (bytes)

The amount of data in bytes.

integer format: int64
<= 1000000000000000
commission_amount
required
integer
created
required
string format: date-time
Examples
Exampleexample

Example response

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"email": "[email protected]",
"status": "pending",
"package": {
"id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Residential 10 GB",
"alias": "residential-10gb",
"is_unlimited_data": true,
"targeting_options": {
"package": "package",
"split_char": "-",
"value_char": "-",
"continent": "continent",
"country": "us",
"region": "california",
"city": "los_angeles",
"asn": "15169",
"isp": "comcast",
"username": "developer",
"pool": "residential",
"location": "location",
"location_format": "location format",
"session": "session",
"session_mode_tag": "session mode tag",
"session_ttl": "session ttl",
"session_ttl_format": 1,
"os": "os",
"os_combined": true,
"os_split_char": "os split char",
"os_linux": "os linux",
"os_windows": "os windows",
"os_ios": "os ios",
"os_macos": "os macos",
"os_android": "os android"
}
},
"price_total": 1,
"data": 1073741824,
"commission_amount": 1,
"created": "2026-07-01T12:30:00Z"
}
]
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
Exampleexample

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}