Skip to content
Longport Whale
Agent Billing

Edit Billing Company Fee

Submitted by the "Edit" sub-page on the Agent Billing page, used to edit an agent (institution) rate. It changes live billing configuration — call with caution.

PUThttps://b-api.longbridge.xyz/billing/company_fee

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

idstringrequired

Company Fee Record ID. The rate record id; displayed and submitted with the form when editing.

custodian_idstringrequired

Custodian/Company ID. In edit mode this field is not editable; the original value is only displayed and submitted with the form.

billing_item_idstringrequired

Billing Item ID. The selected billing-item id; populated from the detail data in edit mode.

billing_itemobject

Billing Item Snapshot. A billing-item object, containing fields such as id/name_loc.

metric_typestring

Metric Type. Values come from the billing_fee_metric_type dynamic enumeration and are not fixed.

thresholdstringrequired

Threshold. Required when metric_type is not "charge by contract count"; a numeric string with up to 10 decimal places.

fee_rate_typestringrequired

Fee Rate Type. Enum from billing_package_fee_type_ref: 1=fixed rate (FIXED), 2=floating rate (FLOAT), 6=tiered rate (SINGLE_STEP), 7=floating tiered (FLOAT_SINGLE_STEP); agent billing does not support monthly tiers (3).

calculation_methodstringrequired

Calculation Method. Derived from fee_rate_type: floating types (2, 7) are "2", the rest are "1".

fixed_ratesarray<string>

Fixed Rates. Used when fee_rate_type=1 (fixed rate); each element is { fee_rate: string }.

ratesarray<string>required

Rate Rules. The final rate structure generated based on fee_rate_type; elements contain fields such as gt/lte/fee_rate.

currencystringrequired

Currency. Values come from the global_currency_filter_by_account_channel dynamic enumeration and are not fixed.

minstringrequired

Minimum Fee. A numeric string.

maxstringrequired

Maximum Fee. A numeric string.

max_metricobject

Max Metric Config. The raw form object { max_metric_type, max_metric_rate }.

max_metric_typestring

Max Metric Type. 0 = disabled, 1 = enabled; expanded from max_metric.max_metric_type.

max_metric_ratestring

Max Metric Rate. The rate value when the maximum-ratio limit is enabled; divided by 100 before submission.

granularitystringrequired

Granularity. Values come from the billing_fee_granularity dynamic enumeration and are not fixed.

min_metricobject

Min Metric Config. The form's raw object { min_metric_type, min_metric_rate }.

min_metric_typestring

Min Metric Type. Expanded from min_metric.min_metric_type.

min_metric_ratestring

Min Metric Rate. Expanded from min_metric.min_metric_rate.

cutoff_methodstringrequired

Cutoff Method. Values come from the billing_fee_cutoff_method dynamic enumeration and are not fixed.

cutoff_digitsstringrequired

Cutoff Digits. Values come from the billing_cutoff_digit dynamic enumeration and are not fixed.

metric_cycle_typenumber

Metric Cycle Type. Fixed logic: 4 when fee_rate_type is monthly-tiered (3), otherwise 0; always 0 for agent billing.

special_feesarray<string>

Special Fee Conditions. The array of differentiated rate conditions maintained by the SpecialFeeFields component.

audit_frontend_resourceobject

Frontend Audit Snapshot. Audit metadata attached on submit; in the edit scenario it always includes { isEdit: true } and the original detail data.

Responses

HTTP 200No confirmable field definitions are available for the response yet.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs