Skip to content

List affiliate package commissions

GET
/packages/commissions
curl --request GET \
--url 'https://api.proxyrequest.com/api/v1/packages/commissions?pricing_unit=data&type=residential' \
--header 'Authorization: Bearer <token>'

Returns commission rates, paid earnings, pending earnings, and referred order totals for each package visible to an approved marketer.

alias
string
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

pricing_unit
string
Allowed values: data proxy

Unit customers purchase — determines how the billing model amounts are interpreted. * data - Data * proxy - Proxy

type
string
Allowed values: residential static
  • static - Static * residential - Residential

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
required
string format: uuid
name
required
string
pricing
required
commission_rate
required
number format: double
total_earnings
required
number format: double
total_orders
required
integer
pending
required
number format: double
billing_model
required
Examples
ExamplePackageCommissions

Package commissions

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440002",
"name": "Residential 10 GB",
"pricing": {
"price": 25,
"currency": "USD"
},
"commission_rate": 10,
"total_earnings": 42.5,
"total_orders": 17,
"pending": 7.5,
"billing_model": {
"type": "fixed"
}
}
]
}

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