Savings Plans

Create savings plan

Changed on

Creates a recurring savings plan that automatically invests a fixed cash amount at a defined frequency.

Set type to INSTRUMENT to invest in a single instrument, or PORTFOLIO to distribute the investment across the account's portfolio allocation.

post/savings_plans

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/savings_plans
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: savings_plans:admin)

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

OR

Response

Savings plan object

idstring uuid required

Universally Unique Identifier (UUID) of a savings plan.

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

Unique identifier of the user, as a UUID.

account_idstring uuid required

Universally Unique Identifier (UUID) of the account.

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

A positive decimal amount, as a string.

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

Changes

  • 48b66c49067aRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status