Skip to content

Create Commission Plan

POST
/marketplace/commissions/plans

Write a new plan version. Created as draft; activate it separately.

Pass previous_version_id to supersede an existing plan - the new row keeps that plan’s plan_id and takes the next version number. Omit it to start a new plan.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
previous_version_id
Any of:
string format: uuid
terms
required
object
currency
string
default: USD
effective_from
required
string format: date
effective_until
Any of:
string format: date
eligibility_policy
required
string
>= 1 characters <= 4000 characters
name
required
string
>= 1 characters <= 120 characters
quality_policy
string
"" <= 2000 characters
rules
required
Array<object>
>= 1 items <= 100 items
object
name
required
string
>= 1 characters <= 120 characters
product_ids
Array<string>
<= 500 items
stages
required
Array<object>
>= 1 items <= 60 items
object
fixed_amount
Any of:
number
from_month
integer
default: 1 >= 1
percentage
Any of:
number
<= 100
quality_percentage
Any of:
number
<= 100
through_month
Any of:
integer
>= 1
target
string
default: default
Allowed values: default group product

Responses

201

Successful Response

object
data
required

One record, or one action result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string