Skip to content
Rate Setups (By FD)

Edit Org Package Ref

Edits an organization package-reference configuration. Fields are largely the same as the add operation, except editing locates the record by default_id and no longer submits org_id (the organization cannot be changed).

Request parameters

  • Required: default_id (record ID), default_package_id (default package ID)
  • Optional: cash_package_id, financing_package_id, bo_package_id, allow_package_ids (allowed package ID list), personal_allow_item_ids (allowed personalized fee-item ID list)
  • See the field descriptions for the format, value range, and business meaning of each field.
  • default_id is the record ID of the org package reference. Take id from a row of POST /v1/datasets/booking_org_package_refs.

Risk warning

This operation changes live billing configuration and may affect how customers are actually charged. Verify the target record and parameters before calling.

Result

On success, the operation completes; the resulting state and returned data follow the 200 response definition.

PUThttps://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_update

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

Request body application/json

default_idstringrequired

Record ID of the org package reference being edited. Take id from a row of POST /v1/datasets/booking_org_package_refs. This field is required.

default_package_idstring

Default Package ID associated with this request.

Candidate values come from the fee-package (customer-group) list returned by GET /v1/datasets/refs/billing_packages; use the returned entry's key as the value.

cash_package_idstring

Cash Package ID associated with this request.

Candidate values come from the fee-package (customer-group) list returned by GET /v1/datasets/refs/billing_packages; use the returned entry's key as the value.

financing_package_idstring

Financing Package ID associated with this request.

Candidate values come from the fee-package (customer-group) list returned by GET /v1/datasets/refs/billing_packages; use the returned entry's key as the value.

bo_package_idstring

BO Package ID associated with this request.

Candidate values come from the fee-package (customer-group) list returned by GET /v1/datasets/refs/billing_packages; use the returned entry's key as the value.

allow_package_idsarray<string>

Submit Allow Package IDs as a JSON array.

Candidate values come from the fee-package (customer-group) list returned by GET /v1/datasets/refs/billing_packages; use the returned entry's key as the value.

personal_allow_item_idsarray<integer>

Submit Personal Allow Item IDs as a JSON array.

audit_frontend_resourceobject

Caller-provided audit context used for operation logging.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

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