Skip to content

Preview Commission

POST
/marketplace/commissions/preview

Dry-run a plan against one collection. Writes nothing, pays nobody.

Send the terms you are about to save and a sample collection; the answer is exactly what POST /commissions/entries would compute for it. Use it before activating a plan version, because activation is the act that decides what people are paid. An unparseable plan is a 422.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
collection
required
object
cohort_id
required
string
>= 1 characters <= 200 characters
collected_on
required
string format: date
currency
string
default: USD
customer_id
required
string
>= 1 characters <= 200 characters
eligible_amount
required
Any of:
number
> 0
event_id
required
string
>= 1 characters <= 200 characters
evidence
required
string
>= 1 characters <= 4000 characters
full_collection
boolean
invoice_line_id
required
string
>= 1 characters <= 200 characters
paid_month
required
integer
>= 1
product_id
required
string
>= 1 characters <= 200 characters
quality_approved
Any of:
boolean
quality_evidence
string
"" <= 2000 characters
verified
required
boolean
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

200

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