Claw a commission back after a refund
Mark a pending, approved or paid commission as reversed and take the sale off the partner totals. Answers 409 invalid_transition when the commission is already reversed or was rejected, and 404 commission_not_found for an unknown id. The reply is the full commission, including affiliate_name. Clawing back a paid commission keeps it counted as paid out and adds it to clawed_back_after_payment_cents so you can recover it.
https://app.softsolz.uk/api/v1/services/affiliates/affiliates/commissions/{id}/reverseRecent Requests
Kept only in this browserPath Params
idstringrequiredHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Idempotency-KeystringOptional idempotency key for safe retries.
Body Params
reasonstringWhy the commission is clawed back. Defaults to "Reversed".
Response
Response Body
idstringCommission id.affiliate_idstringPartner who earned it.affiliate_namestring | nullPartner name.contact_idstring | nullCRM contact who made the purchase, or null.subject_typestringWhat kind of sale this is.subject_idstringYour reference for the sale (an invoice id, order number and so on).subject_referencestring | nullThe reference you sent with the sale (subject_reference), otherwise the quote or invoice number when the sale is a SoftSolz quote or invoice, otherwise null.subject_link_validbooleanTrue when the sale matches a real quote or invoice in this workspace, so it can be linked to. False for a reference that is only text.subject_record_idstring | nullId of the matching quote or invoice when subject_link_valid is true, or null.sale_amount_centsintegerSale value in minor units.commission_centsintegerCommission earned, in minor units of the partner currency.currencystringCurrency the commission is paid in (the partner currency).sale_currencystringCurrency the sale was made in.period_indexintegerBilling period of a recurring sale. 0 is the first sale.rate_snapshotobject | nullThe commission rate that applied when the sale was credited.statusstringWhere the commission is in its life: pending, approved, paid, rejected or reversed.hold_untilstring | nullCommission cannot be paid before this time (the refund window), or null.reversed_atstring | nullWhen the commission was clawed back, or null.reversal_reasonstring | nullWhy the commission was clawed back, or null.payout_item_idstring | nullPayout line this commission is being paid on, or null.approved_atstring | nullWhen the commission was approved, or null.paid_atstring | nullWhen the commission was paid, or null.created_atstringWhen the sale was credited.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/affiliates/affiliates/commissions/{id}/reverse \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "reason": "Customer refunded the order."}'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 200
{ "data": { "id": "305", "affiliate_id": "12", "affiliate_name": "Acme Media", "contact_id": null, "subject_type": "invoice", "subject_id": "INV-1042", "subject_reference": "Paper invoice 7", "subject_link_valid": false, "subject_record_id": null, "sale_amount_cents": 250000, "commission_cents": 37500, "currency": "GBP", "sale_currency": "GBP", "period_index": 0, "rate_snapshot": { "commission_type": "percent", "commission_percent": "15.000", "commission_amount_cents": null, "from": "affiliate", "tier_id": null }, "status": "pending", "hold_until": "2026-10-31T10:15:00.000Z", "reversed_at": null, "reversal_reason": null, "payout_item_id": null, "approved_at": null, "paid_at": null, "created_at": "2026-10-01T10:15:00.000Z" }}