curl -X GET "https://api.affonso.io/v1/commissions/com_abc123" \
-H "Authorization: Bearer sk_live_your_api_key"
curl -X GET "https://api.affonso.io/v1/commissions/com_abc123?expand=affiliate,referral" \
-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"
}
}
{
"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",
"affiliate": {
"id": "aff_789ghi",
"name": "John Doe",
"email": "john@example.com",
"tracking_id": "PARTNER123",
"source": "api",
"partnership_status": "APPROVED",
"onboarding_completed": true,
"program_id": "prog_123xyz",
"group_id": null,
"created_at": "2024-01-15T10:30:00Z"
},
"referral": {
"id": "ref_456def",
"affiliate_id": "aff_789ghi",
"program_id": "prog_123xyz",
"email": "customer@example.com",
"customer_id": "cust_123",
"subscription_id": null,
"status": "customer",
"created_at": "2024-01-18T12:00:00Z",
"converted_at": "2024-01-18T12:00: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"
curl -X GET "https://api.affonso.io/v1/commissions/com_abc123?expand=affiliate,referral" \
-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"
}
}
{
"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",
"affiliate": {
"id": "aff_789ghi",
"name": "John Doe",
"email": "john@example.com",
"tracking_id": "PARTNER123",
"source": "api",
"partnership_status": "APPROVED",
"onboarding_completed": true,
"program_id": "prog_123xyz",
"group_id": null,
"created_at": "2024-01-15T10:30:00Z"
},
"referral": {
"id": "ref_456def",
"affiliate_id": "aff_789ghi",
"program_id": "prog_123xyz",
"email": "customer@example.com",
"customer_id": "cust_123",
"subscription_id": null,
"status": "customer",
"created_at": "2024-01-18T12:00:00Z",
"converted_at": "2024-01-18T12:00:00Z"
}
}
}
Path Parameters
string
required
The unique identifier of the commission to retrieve
Query Parameters
string
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.boolean
Always
true for successful responsesobject
The commission object.
Show Data Object Properties
Show Data Object Properties
string
Unique identifier for the commission
string
The referral ID this commission is associated with
string
The affiliate ID who will receive this commission
string
The affiliate program ID
number
The total sale/transaction amount (automatically converted to team currency if different)
string
The currency code for the sale (3 letters, e.g., USD, EUR). Represents the team’s currency after conversion if applicable.
number
The commission amount to be paid
string | null
The currency code for the commission amount. Can be
null when the transaction exists without an affiliate earning.string
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).string
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).integer | null
Number of days commission is on hold before becoming available for payment
string | null
Payment intent ID if provided
string | null
Invoice ID if linked to a payout invoice
string
ISO 8601 timestamp of when the commission was created
string
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"
curl -X GET "https://api.affonso.io/v1/commissions/com_abc123?expand=affiliate,referral" \
-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"
}
}
{
"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",
"affiliate": {
"id": "aff_789ghi",
"name": "John Doe",
"email": "john@example.com",
"tracking_id": "PARTNER123",
"source": "api",
"partnership_status": "APPROVED",
"onboarding_completed": true,
"program_id": "prog_123xyz",
"group_id": null,
"created_at": "2024-01-15T10:30:00Z"
},
"referral": {
"id": "ref_456def",
"affiliate_id": "aff_789ghi",
"program_id": "prog_123xyz",
"email": "customer@example.com",
"customer_id": "cust_123",
"subscription_id": null,
"status": "customer",
"created_at": "2024-01-18T12:00:00Z",
"converted_at": "2024-01-18T12:00:00Z"
}
}
}
Was this page helpful?
⌘I