Skip to content
Rate Setups(Customized)

Edit Single Item Package

Edits a personalized-fee configuration.

Request parameters

  • Required: id (personalized-fee id, in the path), name (name), fee (fee-rate details)
  • Optional: aaid (securities account)
  • The fee structure matches the fee returned by the personalized-fee detail endpoint.

Risk warning

This operation changes live billing configuration and may affect how customers are actually charged. Verify the target record and parameters before calling.

Result

On success, the change is applied and the response data is an empty object.

PUThttps://b-api.lbkrs.com/billing/single_item_package/{id}

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_charging.lb_hk_billingpackage_update

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Parameters

idstringRequired

Id of the single item package to edit.

Request body application/json

namestringrequired

Single item package name.

aaidstring

Associated securities account (optional).

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

feeobjectrequired

Fee detail. Same structure as the fee returned by "Single Item Package Detail" (billing_item_id, currency, min / max / threshold, rates, special_fees, metric_type, granularity, etc.).

Child attributes
billing_item_idstring

Billing item (fee scenario) ID.

currencystring

Currency code, e.g. HKD.

cutoff_digitsinteger

Number of digits kept when cutting off.

cutoff_methodinteger

Rounding (cut-off) method code.

fee_rate_typeinteger

Fee rate type code.

granularityinteger

Metering granularity code.

calculation_methodinteger

Calculation method code.

maxstring

Fee cap (numeric string).

minstring

Fee floor (numeric string).

thresholdstring

Threshold (numeric string).

metric_typeinteger

Metering method code.

metric_cycle_typeinteger

Metering cycle type code.

max_metric_typeinteger

Cap metering method code; 0 means no cap.

min_metric_typeinteger

Floor metering method code; 0 means no floor.

max_metric_ratestring

Cap rate.

min_metric_ratestring

Floor rate.

metric_type_bill_amount_item_idsarray<string>

Secondary billing item IDs.

special_feesarray<object>

Custom fee list; pass an empty array when none.

ratesarray<object>

Rate bands, at least one.

Child attributes
gtstring

Band lower bound (exclusive).

ltestring

Band upper bound (inclusive); 0 means no upper bound.

fee_ratestring

Fee rate for this band.

minstring

Minimum fee for this band.

Responses

HTTP 200The request was processed successfully. The response data is an empty object.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs