Skip to content
Fee Logic Setups

Charging Scene Detail

Retrieve the full configuration of a single charging scene (billing item) by id.

Request parameters

  • Required: id (charging scene id), supplied in the path.

Result

On success, data contains the full configuration of the charging scene. See the 200 response fields for the meaning of each field.

GEThttps://b-api.longbridge.xyz/billing/billing_item/{id}

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Charging scene id, supplied in the path.

Responses

HTTP 200The request was processed successfully. data contains the full configuration of the charging scene.
Standard response envelopecodemessagedata
dataobjectdata structure

Full configuration of the charging scene.

idstring

Charging scene id.

biz_typeinteger

Business type. The value comes from the billing_business_type_all data dictionary and determines the available downstream options (such as metric type and billing object).

Call GET /v1/datasets/refs/billing_business_type_all to retrieve the current data dictionary.

basis_typeinteger

Billing basis type, consistent with basis_object.basis_type used when creating or editing.

basisstring

Billing basis value (such as currency or underlying), depending on basis_type.

metric_typeinteger

Metric type. The value comes from the billing_metric_type data dictionary; the actual allowed range follows the field rules returned by GET /billing/item_fields for the given biz_type.

directioninteger

Billing direction. The value comes from the billing_item_direction data dictionary; the actual allowed range follows the field rules returned by GET /billing/item_fields for the given biz_type.

granularityinteger

Billing granularity. The value comes from the billing_granularity data dictionary; the actual allowed range follows the field rules returned by GET /billing/item_fields for the given biz_type.

config_typeinteger

Configuration type.

fee_rate_typeinteger

Fee rate type.

name_idstring

Associated billing name id (references a billing name entry).

name_locstring

Localized display text of the billing name.

coefficientinteger

Billing coefficient (multiplier).

divisorinteger

Billing divisor.

cutoff_methodinteger

Rounding / truncation method.

cutoff_digitsinteger

Number of digits kept for rounding / truncation.

benchmark_ratestring

Benchmark rate.

metric_type_bill_amount_item_idsarray<string>

When metric_type is "Calculation Based On Existing Scenarios", the list of existing charging scene ids used as the billing base; otherwise usually an empty array.

copywriting_showinteger

Whether the charging scene copywriting is shown: 0 hidden, 1 shown.

contentobject

Charging scene copywriting content, a localized object (zh-CN / zh-HK / en).

remarkobject

Remark, a localized object (zh-CN / zh-HK / en).

merchantobject

Merchant information, a localized object (zh-CN / zh-HK / en).

namestring

Billing name (may be null; usually displayed via name_id / name_loc).

created_atstring

Creation time, Unix timestamp in seconds.

updated_atstring

Last update time, Unix timestamp in seconds.

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