curl -X PATCH "https://api.affonso.io/v1/program/payment-terms" \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"commission_rate": 25,
"cookie_lifetime": 90,
"auto_payout": true,
"payment_frequency": "weekly"
}'
{
"success": true,
"data": {
"commission_type": "percentage",
"commission_rate": 25,
"commission_duration": "lifetime",
"commissions_limit": null,
"commissions_hold_days": 14,
"payment_threshold": 5000,
"payment_frequency": "weekly",
"payment_methods": ["paypal", "wise"],
"custom_payment_terms": "Payouts are processed within 10 business days.",
"cookie_lifetime": 90,
"auto_payout": true,
"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
Update Payment Terms
Update commission rates, payment frequency, cookie lifetime, and other payment settings
PATCH
/
v1
/
program
/
payment-terms
curl -X PATCH "https://api.affonso.io/v1/program/payment-terms" \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"commission_rate": 25,
"cookie_lifetime": 90,
"auto_payout": true,
"payment_frequency": "weekly"
}'
{
"success": true,
"data": {
"commission_type": "percentage",
"commission_rate": 25,
"commission_duration": "lifetime",
"commissions_limit": null,
"commissions_hold_days": 14,
"payment_threshold": 5000,
"payment_frequency": "weekly",
"payment_methods": ["paypal", "wise"],
"custom_payment_terms": "Payouts are processed within 10 business days.",
"cookie_lifetime": 90,
"auto_payout": true,
"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
}
}
Update your program’s payment terms. All fields are optional — only include the fields you want to change. If no payment terms exist yet, they will be created with sensible defaults for any fields not provided.
Body Parameters
ISO 3166-1 alpha-2 country code (e.g.
US, DE). Must be exactly 2 characters. Set to null to clear.Response
Returns the updated payment terms object. Same structure as the Get Payment Terms response.curl -X PATCH "https://api.affonso.io/v1/program/payment-terms" \
-H "Authorization: Bearer sk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"commission_rate": 25,
"cookie_lifetime": 90,
"auto_payout": true,
"payment_frequency": "weekly"
}'
{
"success": true,
"data": {
"commission_type": "percentage",
"commission_rate": 25,
"commission_duration": "lifetime",
"commissions_limit": null,
"commissions_hold_days": 14,
"payment_threshold": 5000,
"payment_frequency": "weekly",
"payment_methods": ["paypal", "wise"],
"custom_payment_terms": "Payouts are processed within 10 business days.",
"cookie_lifetime": 90,
"auto_payout": true,
"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?
