Skip to main content
POST
Subscribe to a right offering

Authorizations

Authorization
string
header
required

Bearer token used for protected REST API requests.

Body

application/json

Right subscription request payload. symbol and shares are required.

Payload for submitting a right subscription request.

symbol
string
required

Symbol to subscribe.

shares
integer
required

Number of new shares to subscribe.

Required range: x >= 1

Response

Submitted right subscription request.

Response returned after submitting a right subscription request.

status
string

success or failed.

message
string

Human-readable result.

subscription
object

Right subscription request/entitlement for one account.

heldAmount
number

Credit amount held by the backend.