Billing Plan

Queries billing packages, which bundle a set of fee rules so charging configurations can be maintained and reused at the package level.

Request parameters

Combine business filters through filters (see the filters field notes below for the available fields), and use page, page_size, and orderBy to control paging and sorting.

Business notes

Each record includes the package ID, package type, name, bound merge rule, owning organization, customer count, creation method, and approval status.
A package groups the rate rules of multiple billing scenarios and can link to a merge rule and to organization package bindings.
Used to maintain and roll out standardized charging plans to customers or organizations in bulk.

Returns

On success, returns the matched record list with pagination. See the response definition for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/booking_packages

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_charging.lb_hk_billingpackage_query

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

namestring

Filters results by Package.

aaidstring

Filters results by Client.

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.

org_idstring

Filters results by Organization Name.

Values are dynamic. Call GET /v1/datasets/refs/member_organizations to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

typestring

Filters results by Package Type.

Allowed values: 1 Global Package, 2 General Package

Values

1: Global Package
2: General Package

updated_atobject

Filters results by Updated At.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

billing_packages.IDstring

Filters results by Client Group ID.

statestring

Filters results by State.

Allowed values: 0 Effective, 1 Not Effective

Values

0: Effective
1: Not Effective

pendingstring

Filters results by Approved.

Allowed values: 0 Approval Completed, 1 Pending Approvals

Values

0: Approval Completed
1: Pending Approvals

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Billing Plan records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

typestring

Returned value: Package Type.

type_valstring

Raw value of type. The type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

namestring

Returned value: Package Name.

member_cntstring

Returned value: Client Count.

package_market_rule_namestring

Returned value: Combination Rule.

statestring

Returned value: State.

state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Created At. The date or time format follows the value returned by the API.

org_idstring

Returned value: Organization Name.

org_id_valstring

Raw value of org_id. The org_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

admin_idstring

Returned value: Last Updated.

admin_id_valstring

Raw value of admin_id. The admin_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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 POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/booking_packages' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "44703",
        "type": "General Package",
        "type_val": "2",
        "name": "自动化套餐收费20260112111529",
        "member_cnt": "1220195",
        "package_market_rule_name": "自动化name20250603115758,自动化name20250601113731,自动化name20250608120058",
        "state": "Effective",
        "state_val": "0",
        "created_at": "1749733012",
        "org_id": "autotest1",
        "org_id_val": "475927761255951",
        "updated_at": "1784183886",
        "admin_id": "Zhang San",
        "admin_id_val": "7003"
      }
    ],
    "total": 36
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/booking_packages/download

lb_hk_charging.lb_hk_billingpackage_query

Export options Export records Download result