Skip to content
Rate Setups (By FD)

Add Org Package Ref

Add Org Package Ref.

Request parameters

  • Required: org_id (Org ID), default_package_id (Default Package ID)
  • Optional: cash_package_id (Cash Package ID), financing_package_id (Financing Package ID), bo_package_id (BO Package ID), allow_package_ids (Allow Package IDs), personal_allow_item_ids (Personal Allow Item IDs)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/billing/org_package_ref

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

org_idstringrequired

Org ID associated with this request.

Candidate values come from the organization list returned by GET /v1/datasets/refs/member_organizations; use the returned entry's key as the value.

default_package_idstringrequired

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<string>

Submit Personal Allow Item IDs as a JSON array.

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