Skip to main content
POST
Quote a commission

Authorizations

Authorization
string
header
required

Workspace API key, e.g. sa_live_…. Scopes: read / write / track / *.

Body

application/json
affiliate_id
string<uuid>
required
amount
number
required

Sale amount in major units (99 = $99).

currency
string

Three-letter code. Defaults to your workspace currency.

product_id
string

Stripe product id (prod_…) the sale is for.

billing_interval
enum<string>
Available options:
one_time,
month,
year
customer_email
string

The buyer, so self-referral and other holds are checked.

occurred_at
string<date-time>

When the sale happened. Not in the future. Defaults to now.

Response

The quote

object
string
Example:

"commission_quote"

data
object