Read the partner programme

GET /program/affiliates/settings


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_get_affiliate_program_settings`

The partner (affiliate) programme’s defaults: commission on codes and links, the buyer discount, what commission is calculated on, holdback, attribution window, code prefix, terms and UTM. 403 feature_disabled where the programme is not available.

Response `200`

Returns AffiliateProgramSettings.

Field	Type	Description
`revision`	integer
`enabled`	boolean	Whether the partner programme is on. Switched in the Charm admin only.
`applications_open`	boolean	Public applications open. Admin only.
`auto_approve`	boolean	Applications approved without review. Admin only.
`commission`	object
`customer_discount`	object
`commission_base`	object
`holdback_days`	integer	Days a commission waits before it can be paid out (refund window).
`link_attribution_window_days`	integer	How long after a click an order still counts for the partner’s link.
`code_prefix`	string	Partner codes start with this.
`terms_url`	string or null	The partner terms page. (nullable)
`allow_self_referral`	boolean	A partner earns on their own orders.
`hub_invite_after_referrals`	integer	Customers are invited to become partners after this many referrals; 0 = straight away.
`hide_order_value`	boolean	Partners do not see order values.
`utm`	object

{
  "revision": 1,
  "enabled": true,
  "applications_open": false,
  "auto_approve": false,
  "commission": {
    "type": "percent",
    "code_rate": 1,
    "link_rate": 1
  },
  "customer_discount": {
    "type": "percentage",
    "value": 1
  },
  "commission_base": {
    "include_shipping": false,
    "include_tax": false,
    "after_discounts": false
  },
  "holdback_days": 1,
  "link_attribution_window_days": 1,
  "code_prefix": "REF",
  "terms_url": "terms url",
  "allow_self_referral": false,
  "hub_invite_after_referrals": 1,
  "hide_order_value": false,
  "utm": {
    "enabled": true,
    "source": "order",
    "medium": "medium",
    "campaign": "campaign"
  }
}

Example

curl -X GET "https://charm.appfleece.app/api/v1/program/affiliates/settings" \
  -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.