Skip to content
Client-side Display

Update Billing Item Copywriting

Edit the content of a billing scenario copy entry.

Billing scenario copy provides the user-facing description text for a specific billing item.

Request parameters

  • This endpoint has no required body parameters; see the field descriptions below. id is supplied in the path.
  • billing_item_id links the billing item, content is the copy text, merchant sets the applicable merchant, and remark is a note. See the field descriptions for each field's format, value range, and business meaning.
  • The path id is the record ID of the billing scenario copy entry. Take id from a row of POST /v1/datasets/booking_item_copywritings.
  • An entry with a pending approval ticket (non-zero ticket_id) cannot be edited, enabled, or disabled until the ticket is processed.

Business notes

Locates the copy entry by the path id and updates it. After saving, the latest content is displayed.

Risk warning

This operation changes customer-facing fee description copy. Verify the content and applicable scope before saving.

Result

On success, the entry is updated; subsequent state and returned data follow the 200 response definition.

PUThttps://b-api.lbkrs.com/v1/billing/billing_item_copywriting/{id}

Authorization

AuthorizationstringheaderRequired

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

Permission

billing.account_fee_info_manage

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

Parameters

idstringRequired

Copywriting ID

Request body application/json

billing_item_idstring

Billing item (fee type) ID. Values come from the billing_item_names reference data Queryable via GET /v1/datasets/refs/billing_item_names.

contentobject

Fee content copy. A multi-locale object keyed by zh-CN/zh-HK/en.

Child attributes
zh-CNstring

Fee content copy (Simplified Chinese).

zh-HKstring

Fee content copy (Traditional Chinese).

enstring

Fee content copy (English).

merchantobject

Charging-party copy. A multi-locale object keyed by zh-CN/zh-HK/en.

Child attributes
zh-CNstring

Charging-party copy (Simplified Chinese).

zh-HKstring

Charging-party copy (Traditional Chinese).

enstring

Charging-party copy (English).

remarkobject

Remark copy. A multi-locale object keyed by zh-CN/zh-HK/en.

Child attributes
zh-CNstring

Remark copy (Simplified Chinese).

zh-HKstring

Remark copy (Traditional Chinese).

enstring

Remark copy (English).

Responses

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

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