Retrieve issuer's subscription by ID

get https://example.com/api/subscriptions/{subscriptionId}/tokens/{tokenId}

Fetch one issuer's subscription by ID from a specific token

Responses

Response body

object

intervals

array of objects

Information regarding the different interval configurations for the subscription.

intervals

object

string

required

alias

string | null

Optional name for the subscription configuration interval.

endDate

date-time | null

Optional end date for the subscription configuration.

fees

object

Fees charged when the investor subscribes for the token.

startDate

date-time

required

Start date for the subscription configuration. Orders can only be placed between the start date and the end date.

subscriptionId

string

required

Id of the subscription the interval applies to.

tokenPrice

string | null

Price assigned to the token during the subscription interval. Once the interval begins, the price cannot be changed, and creating a new interval is recommended for any necessary changes. This feature is only applicable to close-ended subscriptions.

caps

object

Limits to investable capital amounts in this token measured in base currency.

totalInvestedAmount

string

required

Total investment amount accumulated for the moment.

type

string

required

The subscription can either be open-ended or close-ended.

CLOSE_ENDED OPEN_ENDED

autoMinting

boolean

required

If enabled, tokens will be automatically minted once payment is confirmed.

autoPriceSetAfterValuation

boolean

required

If enabled, the token price will be automatically set after each token NAV update.

alias

string

Name of the subscription

createdAt

date-time

required

Date of creation in format yyyy-mm-dd hh:mm:ss

distributor

boolean

paymentBeforeMinting

boolean

Defaults to true

Optional boolean that enables payment before minting.

paymentInputTokenQuantity

boolean

Defaults to true

Input quantity of tokens in order creation.

paymentInputAmountToPay

boolean

Defaults to false

Input amount, including fees, to pay in order creation.

paymentInputNetInvestment

boolean

Defaults to false

Input net amount, without fees, to pay in order creation.

paymentMethods

object

required

JSON object with information regarding payment methods.

Has additional fields

baseCurrency

string

required

Base currency for the subscription. It will be used as the reference point for determining the value of tokens. It establishes the token price and sets the standard for valuation.

supportedCurrencies

array of strings

required

List of supported currencies. When investors choose to invest using a payment currency different from the Base Currency, the platform calculates the exchange rate between them to determine the Amount to pay.

supportedCurrencies*

templates

object

required

JSON object with information regarding payment methods.

Has additional fields

tokenId

string

required

Id of the token the subscription belongs to.

updatedAt

date-time

Date of the last update in format yyyy-mm-dd hh:mm:ss.

supportingDocumentsRequired

boolean

Optional boolean to include documents.

calendarId

string | null

Optional id of the calendar the subscription is linked to.

warningText

string

Optional warning text

infoText

string

Optional information text.

blockchainNetwork

string

Blockchain network.

401

Unauthorized

403

Token not manageable with this authentication.

404

Token not found.

Holder not found.

Subscription not found.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/api/subscriptions/subscriptionId/tokens/tokenId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Subscription retrieval successful