Get Billing Item Field Rules

Returns the allowed field values and defaults for each biz_type when creating or editing a billing scenario. Forms use these rules to filter dependent options. This endpoint takes no request parameters.

Request parameters

This endpoint does not accept business parameters.

Result

On success, the endpoint returns the requested data. See the 200 response schema for details.

GEThttps://b-api.longbridge.xyz/billing/item_fields

Authorization

AuthorizationstringheaderRequired

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

Responses

HTTP 200The request was processed successfully. data contains biz_map.

Standard response envelopecodemessagedata

dataobjectdata structure

biz_mapobject

Each key is a biz_type value, such as 1 or 2; see billing_business_type_all for its meaning. Each value contains the field rules for that business type.

Child attributes

fieldsarray<object>

Returned value: List of field rules.

Child attributes

namestring

A field name from the Create Billing Scenario request body, such as divisor, metric_type, granularity, cutoff_method, or benchmark_rate.

allow_optionsarray<string>

Allowed values for the current business type. An empty list means unrestricted.

defaultstring

Returned value: Default Value.

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

Request

curl --request GET \
  --url 'https://b-api.longbridge.xyz/billing/item_fields' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "biz_map": {
      "fields": [
        {
          "name": "string",
          "allow_options": [],
          "default": "string"
        }
      ]
    }
  }
}