Update a subscription

Update an existing subscription
šŸ” Note that the authentication must provide administrative privileges. The required permission is AGENT or OWNER.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
string
length ≤ 255

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

boolean
boolean

Subscription payment ahead of time allowed

boolean

User input for payment type

boolean

User input for payment type

boolean

User input for payment type

string
required

Reference ISO currency

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
paymentMethods
object

Payment methods for the subscription

string

Docusign Integrator Key

string

Docusign RSA Private Key

string

Docusign User ID

docusignTemplateIds
object

Docusign Template IDs

string

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

string

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

string

Calendar Id
Link to a specific Calendar

Responses

400

Subscription update 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.

Open-ended intervals must be last from a chronological viewpoint.

The price of the token has more decimals than the token can handle.

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.

End date is in the past (UTC).

End date is before or equal to the start date.

Duplicate payment method strategy network: {duplicateNetwork}.

Interval overlaps the beginning of another interval.

Interval could not be placed. If you want to have another interval, please close the last one.

Interval overlaps the end of another interval.

The value of the fee is not a number.

A flat fee's value must be positive and greater than zero.

A percentage-based fee's value must be greater than zero and less than a hundred.

Minimum order must be equal or less than the minimum capital.

Maximum order must be equal or less than the maximum capital.

{cap variable} is not a number.

{minCap} must be positive and greater than zero.

{maxCap} must be greater than the {minCap}.

{maxCap} must be positive and greater than zero.

401

Unauthorized

403

Token not manageable with this authentication.

404

Token not found.

Subscription not found.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json