Skip to content
Rights Issues and Tender Offers

Calculate Subscription Fee

Calculates the total fee for a subscription from the event and quantity. Used for confirmation before submission. Call it after the Client enters a quantity and selects submit; the Broker App shows the returned fee in the confirmation dialog, and calls POST /v1/portfolio/corpaction/subscribe/apply after the Client confirms. Also call it before resubscribing to a cancelled order.

This operation only calculates the fee and does not create a subscription order. On failure, show message to the Client and do not submit the subscription. Specify the target account in the x-target-aaid request header.

POSThttps://api.lbkrs.com/v1/portfolio/corpaction/subscribe/calculate_fee

Parameters

x-target-aaidstringheaderRequired

The aaid of the target account. The operation returns or processes subscription data for this account.

Request body application/json

ann_idintegerrequired

Corporate action event ID from ann_id of the event, converted to a number

quantitystringrequired

Number of shares to subscribe, as a positive integer string. It cannot exceed max_subscribe_quantity of the event.

Responses

HTTP 200The request succeeded. The response body contains the result of the “Calculate Subscription Fee” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
fee_amountstring

Estimated total fee

currencystring

Fee currency

Whale Docs