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"],
"custom_payment_terms": "Payouts are processed within 10 business days.",
"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"],
"custom_payment_terms": "Payouts are processed within 10 business days.",
"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
boolean
Always
true for successful responsesobject | null
The payment terms object, or
null if not yet configured.Show Data Object Properties
Show Data Object Properties
string
Commission type:
percentage, fixed, or creditsnumber
Commission rate (percentage or fixed amount)
string
Duration model:
lifetime, time_limited, or payment_limitedinteger | null
Maximum commissions per referral, or
null for unlimitedinteger | null
Days to hold commissions before approval
integer
Minimum payout threshold (in cents)
string
Payout frequency:
weekly or monthlyarray
List of accepted payment methods
string | null
Additional free-form payment terms shown to affiliates.
integer
Cookie lifetime in days (1–365)
boolean
Whether automatic payouts are enabled
string
Invoice handling:
none, owner_provides, affiliate_provides, or self_billingstring | null
Invoice number prefix
boolean
Whether affiliates must submit tax forms
string | null
Company name for invoices
string | null
Address line 1
string | null
Address line 2
string | null
City
string | null
Postal code
string | null
ISO 3166-1 alpha-2 country code (e.g.
US, DE)string | null
VAT ID
number | null
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"],
"custom_payment_terms": "Payouts are processed within 10 business days.",
"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