curl -X GET "https://api.affonso.io/v1/commissions/com_abc123" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "com_abc123",
"referral_id": "ref_456def",
"affiliate_id": "aff_789ghi",
"program_id": "prog_123xyz",
"sale_amount": 99.00,
"sale_amount_currency": "USD",
"commission_amount": 9.90,
"commission_currency": "USD",
"status": "ready_for_payment",
"sales_status": "complete",
"hold_period_days": null,
"payment_intent_id": null,
"invoice_id": null,
"created_at": "2024-01-20T15:30:00Z",
"updated_at": "2024-01-20T15:30:00Z"
}
}
Commissions
Get Commission
Retrieve a single commission by ID
GET
/
v1
/
commissions
/
{id}
curl -X GET "https://api.affonso.io/v1/commissions/com_abc123" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "com_abc123",
"referral_id": "ref_456def",
"affiliate_id": "aff_789ghi",
"program_id": "prog_123xyz",
"sale_amount": 99.00,
"sale_amount_currency": "USD",
"commission_amount": 9.90,
"commission_currency": "USD",
"status": "ready_for_payment",
"sales_status": "complete",
"hold_period_days": null,
"payment_intent_id": null,
"invoice_id": null,
"created_at": "2024-01-20T15:30:00Z",
"updated_at": "2024-01-20T15:30:00Z"
}
}
Path Parameters
The unique identifier of the commission to retrieve
Query Parameters
Comma-separated list of related data to include. Valid values:
affiliate, affiliate_program, referral. You can combine multiple values: affiliate,referral.Response
The response includes the commission object with all its details.Always
true for successful responsesThe commission object.
Show Data Object Properties
Show Data Object Properties
Unique identifier for the commission
The referral ID this commission is associated with
The affiliate ID who will receive this commission
The affiliate program ID
The total sale/transaction amount (automatically converted to team currency if different)
The currency code for the sale (3 letters, e.g., USD, EUR). Represents the team’s currency after conversion if applicable.
The commission amount to be paid
The currency code for the commission amount. Can be
null when the transaction exists without an affiliate earning.The commission status. Valid values:
pending (on hold period, auto-updates to ready_for_payment when period expires), pending_manual_approval (same as pending but requires manual approval), ready_for_payment (approved and ready for payout in next cycle, not yet paid), paid (confirmed and already paid out), declined (rejected, not paid and excluded from payouts).The sales/transaction status. Valid values:
open (sale is open/pending), complete (sale completed successfully), trialing (customer is in trial period), failed (sale failed), refunded (sale fully refunded), partial_refunded (sale partially refunded).Number of days commission is on hold before becoming available for payment
Payment intent ID if provided
Invoice ID if linked to a payout invoice
ISO 8601 timestamp of when the commission was created
ISO 8601 timestamp of when the commission was last updated
curl -X GET "https://api.affonso.io/v1/commissions/com_abc123" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "com_abc123",
"referral_id": "ref_456def",
"affiliate_id": "aff_789ghi",
"program_id": "prog_123xyz",
"sale_amount": 99.00,
"sale_amount_currency": "USD",
"commission_amount": 9.90,
"commission_currency": "USD",
"status": "ready_for_payment",
"sales_status": "complete",
"hold_period_days": null,
"payment_intent_id": null,
"invoice_id": null,
"created_at": "2024-01-20T15:30:00Z",
"updated_at": "2024-01-20T15:30:00Z"
}
}
Was this page helpful?
⌘I