Sign in

v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-08-0464108237.1 KB
Cost & Fees

List cost clusters

Top cost clusters for a merchant with their learned rate, any override, and the fit verdict.

get/merchant-account/{merchantId}/cost-clusters

Path parameters

merchantIdstring required

Merchant account id.

Query parameters

limitinteger

Top-N cluster cap.

connectorstring

Scope to one ingested snapshot. Send with account and report_date.

accountstring

Connector-side account. Send with connector and report_date.

report_datestring

Snapshot date, YYYY-MM-DD. Send with connector and account.

ingestion_idstring

Narrow to one ingestion. Required for a per-upload view: two uploads on the same day under the same account share a snapshot.

orderstring

txns ranks by transaction count. Anything else (default) ranks by settled GMV.

Response

Cost clusters

keystring

Opaque cluster key, used in the override PUT/DELETE path.

connectorstring
card_networkstring
variantstring
fundingstring
issuer_countrystring
currencystring
ic_categorystring
ninteger

Transaction count. 0 for an override-only cluster no longer in the top set.

gross_sumnumber double
model_pct_bpsnumber double nullable
model_fixednumber double nullable
override_pct_bpsnumber double nullable
override_fixednumber double nullable
override_updated_atstring nullable
effective_pct_bpsnumber double nullable

Null when the cluster has no usable rate at all.

effective_fixednumber double nullable
source'override' | 'model' | 'segmented'
verdictstring

GOOD, THIN, NON_LINEAR, or "" for an override-only cluster. A non-GOOD rate is shown so it can be corrected - it is not what the router trusts.

card_productstring

Issuer BIN's dominant interchange rate as integer bps ("115"), or "" when the report carried no PAN.