Savings Plans
Retrieve a savings plan
Retrieve a savings plan specified by its ID.
get/savings_plans/{savings_plan_id}
Response
OK
idstring uuid required
created_atstring date-time required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_atstring date-time required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_idstring uuid required
User unique identifier.
account_idstring uuid required
Account unique identifier.
namestring
Savings plan name
type'PORTFOLIO' | 'INSTRUMENT' required
Type of the Savings plan.
- PORTFOLIO -
- INSTRUMENT -
instrument_id_type'ISIN' | 'WKN'
The type of the ID used in the request.
- ISIN - International Securities Identification Number
- WKN - German securities identification code
cash_amountstring required
start_datestring required
First date of the savings plan execution in YYYY-MM-DD format.
currency'EUR' | 'GBP' required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- GBP - Pound Sterling
period'WEEK' | 'MONTH' | 'YEAR' required
Unit of time.
- WEEK -
- MONTH -
- YEAR -
intervalinteger required
Number of periods between executions
status'ACTIVE' | 'CANCELLED'
Status of a Savings Plan.
- ACTIVE -
- CANCELLED -
cancellation_reason'CANCELLED_BY_CLIENT' | 'CANCELLED_BY_UPVEST'
Explains the reason why the savings plan was cancelled .
- CANCELLED_BY_CLIENT: The savings plan was cancelled by the client.
- CANCELLED_BY_UPVEST: The savings plan was cancelled by Upvest.
cancellation_detailsstring
Additional details about the cancellation