---
title: "Preview Commission"
method: POST
path: "/marketplace/commissions/preview"
tags: ["Marketplace"]
---

# Preview Commission

`POST /marketplace/commissions/preview`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/marketplace/commissions/preview`
- Auth: HTTP bearer

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- Preview
  - `terms` PlanTerms, required
    - `name` string, required
    - `currency` 'USD'
    - `effective_from` string, date, required
    - `effective_until` string, date, nullable
    - `quality_policy` string
    - `eligibility_policy` string, required
    - `rules` Rule[], required
      - `name` string, required
      - `target` 'default' | 'group' | 'product'
      - `product_ids` string[]
      - `stages` Stage[], required
        - `from_month` integer
        - `through_month` integer, nullable
        - `percentage` union
          - number
          - string
        - `fixed_amount` union
          - number
          - string
        - `quality_percentage` union
          - number
          - string
  - `collection` Collection, required
    - `event_id` string, required
    - `invoice_line_id` string, required
    - `customer_id` string, required
    - `cohort_id` string, required
    - `product_id` string, required
    - `paid_month` integer, required
    - `collected_on` string, date, required
    - `currency` 'USD'
    - `eligible_amount` union, required
      - number
      - string
    - `quality_approved` boolean, nullable
    - `evidence` string, required
    - `quality_evidence` string
    - `full_collection` boolean
    - `verified` true, required

## Response `200`

Successful Response

- ApiResponseMarketplacePayload
  - `data` MarketplacePayload, required: One record, or one action result.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)