List Cost Clusters

curl --request GET \
  --url http://localhost:8080/merchant-account/{merchant_id}/cost-clusters \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:8080/merchant-account/{merchant_id}/cost-clusters"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/merchant-account/{merchant_id}/cost-clusters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/merchant-account/{merchant_id}/cost-clusters",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/merchant-account/{merchant_id}/cost-clusters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/merchant-account/{merchant_id}/cost-clusters")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "key": "<string>",
    "connector": "<string>",
    "card_network": "<string>",
    "variant": "<string>",
    "funding": "<string>",
    "issuer_country": "<string>",
    "currency": "<string>",
    "ic_category": "<string>",
    "n": 123,
    "gross_sum": 123,
    "model_pct_bps": 123,
    "model_fixed": 123,
    "override_pct_bps": 123,
    "override_fixed": 123,
    "override_updated_at": "<string>",
    "effective_pct_bps": 123,
    "effective_fixed": 123,
    "verdict": "<string>",
    "card_product": "<string>",
    "segments": [
      {
        "seg_idx": 123,
        "lo": 123,
        "hi": 123,
        "pct_bps": 123,
        "fixed": 123,
        "bps_rmse": 123,
        "n": 123,
        "gross_sum": 123
      }
    ]
  }
]

GET

merchant-account

{merchant_id}

cost-clusters

List Cost Clusters

curl --request GET \
  --url http://localhost:8080/merchant-account/{merchant_id}/cost-clusters \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:8080/merchant-account/{merchant_id}/cost-clusters"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/merchant-account/{merchant_id}/cost-clusters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/merchant-account/{merchant_id}/cost-clusters",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/merchant-account/{merchant_id}/cost-clusters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/merchant-account/{merchant_id}/cost-clusters")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "key": "<string>",
    "connector": "<string>",
    "card_network": "<string>",
    "variant": "<string>",
    "funding": "<string>",
    "issuer_country": "<string>",
    "currency": "<string>",
    "ic_category": "<string>",
    "n": 123,
    "gross_sum": 123,
    "model_pct_bps": 123,
    "model_fixed": 123,
    "override_pct_bps": 123,
    "override_fixed": 123,
    "override_updated_at": "<string>",
    "effective_pct_bps": 123,
    "effective_fixed": 123,
    "verdict": "<string>",
    "card_product": "<string>",
    "segments": [
      {
        "seg_idx": 123,
        "lo": 123,
        "hi": 123,
        "pct_bps": 123,
        "fixed": 123,
        "bps_rmse": 123,
        "n": 123,
        "gross_sum": 123
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

JWT token obtained from /auth/login

Path Parameters

merchant_id

string

required

Query Parameters

limit

integer<int32> | null

connector

string | null

account

string | null

report_date

string | null

Response

200 - application/json

key

string

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

connector

string

card_network

string

variant

string

funding

string

issuer_country

string

currency

string

ic_category

string

integer<int64>

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

gross_sum

number<double>

model_pct_bps

number<double> | null

model_fixed

number<double> | null

override_pct_bps

number<double> | null

override_fixed

number<double> | null

override_updated_at

string | null

effective_pct_bps

number<double> | null

Null when the cluster has no usable rate at all.

effective_fixed

number<double> | null

source

enum<string>

Available options:

override,

model,

segmented

verdict

string

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_product

string

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

segments

object[]

Recovered per-segment rates for a capped/tiered cluster. Empty for an ordinary GOOD cluster.

Show child attributes

Overview

OpenAPI: Health

OpenAPI: Gateway Decision

OpenAPI: Score Feedback

OpenAPI: Merchant Account

OpenAPI: Routing Rules

OpenAPI: Rule Configuration

OpenAPI: Auth And API Keys

OpenAPI: Analytics

OpenAPI: Compatibility And Config

OpenAPI: Connector Costs & Ingestion

OpenAPI: Feature Flags & Autopilot

API Examples (curl flows)

List Cost Clusters

Authorizations

Path Parameters

Query Parameters

Response