Actions35
- Commission Actions
- Custom API Actions
- Promo Code Actions
- Promoter Actions
- Referral Actions
- Tracking Actions
Commission → Create Sale Commission
AI-generatedSummary
Create a sale commission record in the FirstPromoter system linked to a specific referral and sale event.
Inputs
- Referral ID (required) — ID of the Referral to associate the commission with.
- Sale Amount (required) — The sale amount on which the commission is based. For zero-decimal currencies like JPY, provide a whole number. For other currencies, multiply the amount by 100.
- Event ID (required) — ID of the event generated by the billing provider for this sale.
- Event Date — Date and time of the sale event.
- Internal Note — Internal note about the commission visible only to the team.
- External Note — External note about the commission visible to both internal team and promoters.
- Notify Promoter — Boolean flag indicating whether to send an email notification to the promoter if commission emails are enabled. Defaults to true.
- Billing Period (Optional) — The billing period of the sale event, options: Monthly, One Time, Yearly.
- Plan ID (Optional) — Plan ID related to the sale, corresponding to one of the price IDs.
Output shape
a single JSON array with the created commission record's details
Returns the newly created commission data wrapped in an array.
Examples
Example 1: Creating a sale commission for a referral
Provide referral ID, sale amount, event ID and optionally event date, notes, billing period and plan ID. Set notify promoter to true to send notification.