API Reference

Resolves the best-matching commission plan for the supplied criteria (POST variant).

post
https://platform.routy.app/api/v1/accounts/commission-plans/find-plan

Functionally equivalent to GET /accounts/commission-plans/find-plan but accepts the criteria
in the request body. Requires the AccountsRead policy.

🔐 Required permission: accounts.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The criteria used to resolve the matching commission plan.

Criteria used to resolve the single best-matching commission plan for a conversion context
(account, dates, brand/link/tracker and geo).

int32

Required. The Routy internal account id the plan is being resolved for.

date-time

The date of the originating click.

date-time

The date of the conversion event.

int32 | null

Optional. The brand id to match against.

int32 | null

Optional. The brand-link id to match against.

int32 | null

Optional. The account tracking-profile id to match against.

string | null

The country code (ISO 3166-1 alpha-2) to match against.

string | null

The region code to match against.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request 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