Subscriptions endpoints

Subscription refers to the process where investors register, commits and invest in a financial instrument.

Subscriptions are categorized into two types:

  • CLOSE_ENDED, with a set time frame and price limit
  • OPEN_ENDED, allowing ongoing investments without a defined closing date or price cap.

Agent endpoints to configure Subscription

Run in Postman >

MethodEndpoint
GET/subscriptions/tokens/:tokenId
POST/subscriptions/tokens/:tokenId
GET/subscriptions/:subscriptionId/tokens/:tokenId
PUT/subscriptions/:subscriptionId/tokens/:tokenId
POST/subscriptions/:subscriptionId/tokens/:tokenId/interval
PUT/subscriptions/:subscriptionId/tokens/:tokenId/interval/:intervalId
POST/subscriptions/:subscriptionId/address-pool

Related articles:

Investor endpoints to retrieve Subscription

Run in Postman >

MethodEndpoints
GET/subscriptions/tokens/:tokenId/me
GET/subscriptions/:subscriptionId/tokens/:tokenId/me
GET/subscriptions/:subscriptionId/tokens/:tokenId/exchange-rates/me

Agent Subscription endpoints to order on behalf of an investor

Run in Postman >

MethodEndpoints
GET/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders

Investor Subscription endpoints to order

Run in Postman >

MethodEndpoints
GET/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/me
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/me
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/:orderId/cancel/me
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/:orderId/pending-payment/me

Agent Subscription endpoints to manage subscription orders

Run in Postman >

MethodEndpoints
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/:orderId/cancel
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/set-price
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/:orderId/confirm
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/confirm
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/:orderId/reconciliate
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/cancel
GET/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/:orderId/docusign-url
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/refund
POST/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/mint
GET/subscriptions/:subscriptionId/tokens/:tokenId/investor-orders/csv
POST/subscriptions/:subscriptionId/orders/actions/:subscriptionOrdersActionId/transactions
POST/subscriptions/:subscriptionId/orders/actions/mint
GET/subscriptions/:subscriptionId/orders/actions