API Reference

Retrieves a paginated list of commission plans matching the specified search criteria.

get
https://platform.routy.app/api/v1/accounts/commission-plans

Requires the AccountsRead policy. Paginate with Offset (0-based) and Limit.

🔐 Required permission: accounts.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
Id
array of int32s

Optional. Restricts results to these commission-plan ids.

Id
ProgramId
array of int32s

Optional. Restricts results to these affiliate-program ids.

ProgramId
SoftwareId
array of int32s

Optional. Restricts results to these software (platform) ids.

SoftwareId
AccountId
array of int32s

Optional. Restricts results to these Routy internal account ids.

AccountId
AffiliateId
array of int32s

Optional. Restricts results to these affiliate ids.

AffiliateId
BrandId
array of int32s

Optional. Restricts results to these brand ids.

BrandId
CurrencyCode
array of strings

Optional. Restricts results to these currency codes (ISO 4217).

CurrencyCode
CountryCodes
array of strings

Optional. Restricts results to these country codes (ISO 3166-1 alpha-2).

CountryCodes
RegionCode
array of strings

Optional. Restricts results to these region codes.

RegionCode
Status
array of objects

Optional. Restricts results to commission plans in these statuses. See Platform.Models.CommissionPlans.CommissionPlanStatus.

Status
Allowed:
int32

Optional. Number of items to skip (0-based).

int32

Optional. Maximum number of items to return.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago