curl -X GET "https://api.affonso.io/v1/program/payment-terms" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"commission_type": "percentage",
"commission_rate": 30,
"commission_duration": "lifetime",
"commissions_limit": null,
"commissions_hold_days": 14,
"payment_threshold": 5000,
"payment_frequency": "monthly",
"payment_methods": ["paypal", "wise"],
"cookie_lifetime": 60,
"auto_payout": false,
"invoice_rule": "none",
"invoice_prefix": null,
"require_tax_forms": false,
"owner_company_name": "Acme Inc.",
"owner_address_line_1": "123 Main St",
"owner_address_line_2": null,
"owner_city": "San Francisco",
"owner_postal_code": "94105",
"owner_country": "US",
"owner_vat_id": null,
"owner_vat_rate": null
}
}
Payment Terms
Get Payment Terms
Get commission and payment configuration for your program
GET
/
v1
/
program
/
payment-terms
curl -X GET "https://api.affonso.io/v1/program/payment-terms" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"commission_type": "percentage",
"commission_rate": 30,
"commission_duration": "lifetime",
"commissions_limit": null,
"commissions_hold_days": 14,
"payment_threshold": 5000,
"payment_frequency": "monthly",
"payment_methods": ["paypal", "wise"],
"cookie_lifetime": 60,
"auto_payout": false,
"invoice_rule": "none",
"invoice_prefix": null,
"require_tax_forms": false,
"owner_company_name": "Acme Inc.",
"owner_address_line_1": "123 Main St",
"owner_address_line_2": null,
"owner_city": "San Francisco",
"owner_postal_code": "94105",
"owner_country": "US",
"owner_vat_id": null,
"owner_vat_rate": null
}
}
Retrieve the payment terms configuration including commission rates, payment frequency, cookie lifetime, and invoicing settings.
Response
Always
true for successful responsesThe payment terms object, or
null if not yet configured.Show Data Object Properties
Show Data Object Properties
Commission type:
percentage, fixed, or creditsCommission rate (percentage or fixed amount)
Duration model:
lifetime, time_limited, or payment_limitedMaximum commissions per referral, or
null for unlimitedDays to hold commissions before approval
Minimum payout threshold (in cents)
Payout frequency:
weekly or monthlyList of accepted payment methods
Cookie lifetime in days (1–365)
Whether automatic payouts are enabled
Invoice handling:
none, owner_provides, affiliate_provides, or self_billingInvoice number prefix
Whether affiliates must submit tax forms
Company name for invoices
Address line 1
Address line 2
City
Postal code
ISO 3166-1 alpha-2 country code (e.g.
US, DE)VAT ID
VAT rate percentage
curl -X GET "https://api.affonso.io/v1/program/payment-terms" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"commission_type": "percentage",
"commission_rate": 30,
"commission_duration": "lifetime",
"commissions_limit": null,
"commissions_hold_days": 14,
"payment_threshold": 5000,
"payment_frequency": "monthly",
"payment_methods": ["paypal", "wise"],
"cookie_lifetime": 60,
"auto_payout": false,
"invoice_rule": "none",
"invoice_prefix": null,
"require_tax_forms": false,
"owner_company_name": "Acme Inc.",
"owner_address_line_1": "123 Main St",
"owner_address_line_2": null,
"owner_city": "San Francisco",
"owner_postal_code": "94105",
"owner_country": "US",
"owner_vat_id": null,
"owner_vat_rate": null
}
}
Was this page helpful?
⌘I