Create a token subscription with an interval

post

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

Create a new token subscription with an interval
🔐 Note that the authentication must provide administrative privileges. The required permission is AGENT or OWNER.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tokenId

string

required

Body Params

alias

string

length ≤ 255

Custom name of this subscription (use only letters and numbers; no spaces)

caps

object

Maximum investment amounts

distributor

boolean

endDate

date-time

Closing date for subscription

fees

object

Applicable subscription fees

paymentBeforeMinting

boolean

Subscription payment ahead of time allowed

paymentInputTokenQuantity

boolean

User input for payment type

paymentInputAmountToPay

boolean

User input for payment type

paymentInputNetInvestment

boolean

User input for payment type

baseCurrency

string

required

Reference ISO currency

startDate

date-time

required

Opening date for subscription

supportingDocumentsRequired

boolean

Indicates whether the investor must sign documents when creating a subscription order

supportedCurrencies

array of strings

List of supported currency to participate in this subscription

supportedCurrencies

tokenPrice

string

Price per token to participate in the subscription

paymentMethods

object

Payment methods for the subscription

type

string

required

Note:
If it is CLOSE_ENDED, the tokenPrice value must be set.
If it is OPEN_ENDED, the tokenPrice value must be null.

autoMinting

boolean

Defaults to false

Auto minting

autoPriceSetAfterValuation

boolean

Defaults to true

Auto price set after valuation

docusignIntegratorKey

string

Docusign Integrator Key

docusignRsaPrivateKey

string

Docusign RSA Private Key

docusignUserId

string

Docusign User ID

docusignTemplateIds

object

Docusign Template IDs

warningText

string

Warning text defined by the issuer
It appears in the subscription order creation pop-up in the investor app

infoText

string

Info text defined by the issuer
It appears in the subscription order creation pop-up in the investor app

calendarId

string

Calendar Id
Link to a specific Calendar

Responses

400

Subscription creation failed due to invalid data.

Some of the subscription payment inputs must be set to true (paymentInputNetInvestment, paymentInputAmountToPay, paymentInputTokenQuantity).

Close Ended subscriptions cannot have a calendar linked.

Token price must be undefined when creating open ended subscription.

Open-ended intervals cannot have an end date.

Token price must be defined when creating close ended subscription.

The price of the token must be a positive number greater than zero.

Start date is in the past (UTC).

End date is in the past (UTC).

End date is before or equal to the start date.

401

Unauthorized

403

Token not manageable with this authentication.

404

Token not found.

Holder not found.

Subscription not found.

Calendar not found.

201Subscription creation successful