Skip to content
Longport WhaleLongport Whale
Rate Setups (By FD)

Org Package Ref Detail

Retrieves one org package-reference configuration by its record ID default_id.

Request parameters

  • Required: default_id (org package reference record ID), passed as a query parameter.
  • Take id from a row of POST /v1/datasets/booking_org_package_refs.
  • See the field descriptions for the format and business meaning of each field.
  • The admin console does not call this endpoint.

Returns

On success, returns the organization's package-reference configuration in data. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/billing/org_package_ref

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.

Parameters

default_idstringRequired

Org package reference record ID. Take id from a row of POST /v1/datasets/booking_org_package_refs.

Responses

HTTP 200The request was processed successfully. data contains the organization's package reference configuration.
Standard response envelopecodemessagedata
dataobjectdata structure

Organization package reference configuration (fields derived from the dataset entity, not live-verified).

org_idstring

Organization id.

default_package_idstring

Default package id.

cash_package_idstring

Cash business package id.

bo_package_idstring

BO business package id.

financing_package_idstring

Financing business package id.

personal_allow_item_idsarray<string>

List of charging scene ids for which the organization may configure customized fees.

namesstring

Associated package name display.

allow_package_idsarray<string>

IDs of the packages this organization is allowed to use.

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