Skip to main content
PUT
Update a sale

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Fields to update

saleId
integer
required

The sale to update

name
string

Name of the customer

email
string<email>

Email of the customer

totalEarned
number<float>

Gross value of the sale

commissionRate
number<float>

Commission rate recorded on the sale

commissionEarned
number<float>

Sets the commission recorded for the credited affiliate. Applied to the commission record rather than the sale.

externalId
string

The ID of this sale in your own system

externalInvoiceId
string

The ID of the invoice in your own system

metadata
object

Arbitrary JSON to attach to the sale

Response

The updated sale, including its recalculated commissionEarned.

id
integer<int64>

The sale ID

affiliateId
string<uuid> | null

The affiliate credited with this sale

referralId
string<uuid> | null

The referral this sale belongs to

affiliateProgramId
string<uuid> | null

The affiliate program this sale belongs to

The affiliate link the sale was attributed to

promotionalCodeId
string<uuid> | null

The promotional code used on this sale, if any

externalId
string | null

The ID of this sale in your own system. Unique per program.

externalInvoiceId
string | null

The ID of the invoice in your own system. Unique per program.

name
string | null

Name of the customer

email
string<email> | null

Email of the customer

totalEarned
number<float>

Gross value of the sale

commissionRate
number<float> | null

Commission rate applied to this sale

commissionEarned
number<float> | null

Commission recorded for the credited affiliate. Merged in by the API from the sale's commission record — it is not a column on the sale itself.

taxAmount
number<float>

Tax deducted before commission was calculated

shippingAmount
number<float>

Shipping deducted before commission was calculated

productsBought
string[]

Product identifiers attached to this sale

clicks
integer

Clicks attributed to this sale

status
enum<string>

Whether the sale is live or has been refunded

Available options:
ACTIVE,
REFUNDED
refundedAt
string<date-time> | null

When the sale was marked refunded

paymentTrigger
enum<string>

What triggered the commission for this sale

Available options:
SIGNUP,
PURCHASE,
BONUS,
CONTENT_REWARD
source
enum<string>

Where the sale came from. Sales created through this API have API.

Available options:
UNKNOWN,
API,
INTEGRATION,
MANUAL,
IMPORTED,
AUTOMATED
metadata
object | null

Arbitrary JSON you can attach to the sale

createdAt
string<date-time>

When the sale was recorded

Last modified on July 20, 2026