List partners with commission to pay

GET /program/affiliates/payouts/due

Scope	program:read
Customer session token	Not accepted: call from your server with an API key
Rate limit class	read (limits)
Idempotency key	Not used
MCP tool	charm_list_due_partner_payouts

Every partner with payable commission through through (default today), largest first, with the amount, currency and any open payment request (its payment details masked).

Parameters

Name	In	Type	Description
through (optional)	query	string	A day, YYYY-MM-DD; default today.

Response 200

Returns DuePartnerPayoutList.

Field	Type	Description
through	string	The day the amounts are payable through.
data	array of object

{
  "through": "through",
  "data": [
    {
      "partner": {
        "id": "id",
        "name": "Gold",
        "email": "shopper@example.com",
        "code": "code",
        "status": "active"
      },
      "amount": 1,
      "currency": "EUR",
      "commissions": 1,
      "mixed_currency": false,
      "payment_request": {
        "amount": null,
        "currency": null,
        "requested_at": null,
        "payment_details": null
      }
    }
  ]
}

Example

curl -X GET "https://charm.appfleece.app/api/v1/program/affiliates/payouts/due" \
  -H "Authorization: Bearer chrm_live_..."

Errors

unauthorized · invalid_token · insufficient_scope · access_required · validation_error · rate_limited

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.