Skip to content
Longport WhaleLongport Whale
Rate Setups(Package-based)

Billing Package Detail

Retrieve the full configuration of a single billing package by id.

Request parameters

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

Result

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

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

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Billing package id, supplied in the path.

Responses

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

Full configuration of the billing package.

idstring

Billing package id.

namestring

Package name.

categorystring

Package category identifier.

org_idstring

Organization id the package belongs to.

market_rule_idsarray<string>

List of market rule ids associated with the package; an empty array when none are associated.

feesarray<object>

List of fee item configurations in the package; an empty array when none are configured.

member_cntstring

Number of users enrolled in the package.

show_membersboolean

Whether the package member list is shown.

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