Skip to content
Longport WhaleLongport Whale
Rate Setups(Customized)

Single Item Package Detail

Retrieve the full configuration of a single item package (customized fee) by id.

Request parameters

  • Required: id (single item package id), supplied in the path.

Result

On success, data contains the full configuration. See the 200 response fields for the meaning of each field.

GEThttps://b-api.longbridge.xyz/billing/single_item_package/{id}

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Single item package id, supplied in the path.

Responses

HTTP 200The request was processed successfully. data contains the full configuration of the single item package.
Standard response envelopecodemessagedata
dataobjectdata structure

Full configuration of the single item package.

idstring

Single item package id.

namestring

Single item package name.

feeobject

Fee configuration. Key sub-fields:

  • billing_item_id: id of the associated charging scene.
  • currency: currency.
  • min / max / threshold: billing range and starting threshold.
  • rates: tiered rate list; each tier has gt (greater than), lte (less than or equal), fee_rate, and min (minimum charge).
  • fee_rate_type: fee rate type.
  • metric_type: metric type.
  • granularity: billing granularity.
  • cutoff_method / cutoff_digits: rounding method and retained digits.
  • special_fees: special rate list.
  • billing_item: embedded charging scene configuration; fields are the same as "Find Charging Scene Detail".
  • calculation_method: calculation method.
member_cntstring

Number of users the single item package applies to.

show_membersboolean

Whether the applicable member list is shown.

can_editboolean

Whether the current account can edit this single item package.

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