Savings Plans

List savings plans

Changed on

Returns a paginated list of savings plans for the authenticated client.

Savings plans can be of type INSTRUMENT (recurring buy of a single instrument) or PORTFOLIO (recurring investment distributed across the account's portfolio allocation).

get/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:read, savings_plans:admin)

Query parameters

account_idstring

Filters savings plans by account ID

user_idstring

Filters savings plans by user ID

string

International securities identification number defined by ISO 6166.

OR
string

German securities identification code known as Wertpapierkennnummer.

Filters savings plans by instrument ID (ISIN)

sort'id'

Sort the result by id.

order'ASC'

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

OK

Changes