Institution Plan

Queries organization package bindings used to maintain the billing packages that apply to each organization (customer group).

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

Records the mapping between an organization and its billing packages; each organization can set a default package plus per-business packages such as cash and financing.
Each record includes the organization name, default package, per-business packages, the list of allowed packages, and the operator.
Used to determine the default package combination applied to new customers or customers under an organization.

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_org_package_refs

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_charging.lb_hk_billing_org_package_ref_list

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

org_idstring

Filters results by Org ID.

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.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Institution 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

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

org_idstring

Returned value: Org ID.

org_id_namestring

Returned value: Org name.

org_id_name_valstring

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

default_package_idstring

Returned value: Default Package.

default_package_id_valstring

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

namesstring

Returned value: Optional Package.

operatorstring

Returned value: Operator.

updated_atstring

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

personal_allow_item_idsstring

Returned value: Personal Allow Item Ids.

cash_package_idstring

Returned value: Package To The Cash Account.

cash_package_id_valstring

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

financing_package_idstring

Returned value: Package To The Financing Account.

financing_package_id_valstring

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

bo_package_idstring

Returned value: Package To The OB Account.

bo_package_id_valstring

Raw value of bo_package_id. The bo_package_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_org_package_refs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "org_id": "1",
        "org_id_name": "Standard A/C1",
        "org_id_name_val": "1",
        "default_package_id": "自动化套餐收费20260112111710",
        "default_package_id_val": "18921",
        "names": "自动化套餐收费20260112111710,自动化套餐收费20260112111719,自动化套餐收费20260112111529",
        "operator": "user@example.com",
        "updated_at": "1758783519",
        "personal_allow_item_ids": "",
        "cash_package_id": "自动化套餐收费20260112111529",
        "cash_package_id_val": "44703",
        "financing_package_id": "自动化套餐收费20260112111529",
        "financing_package_id_val": "44703",
        "bo_package_id": "自动化套餐收费20260112111529",
        "bo_package_id_val": "44703"
      }
    ],
    "total": 2
  }
}

Export

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

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

lb_hk_charging.lb_hk_billing_org_package_ref_list

Export options Export records Download result