Upvest · JSON Structure

Investment Api Savings Plan Create Structure

Request body for creating a savings plan.

Type: object Properties: 6 Required: 4
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

SavingsPlanCreate is a JSON Structure definition published by Upvest, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

account_id portfolio_id instrument_id cash_amount currency frequency

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-structure/investment-api-savings-plan-create-structure.json",
  "name": "SavingsPlanCreate",
  "description": "Request body for creating a savings plan.",
  "type": "object",
  "properties": {
    "account_id": {
      "type": "uuid",
      "description": "The account to create the plan for.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "portfolio_id": {
      "type": "uuid",
      "description": "The portfolio to invest into.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "instrument_id": {
      "type": "uuid",
      "description": "The instrument to invest into.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "cash_amount": {
      "type": "string",
      "description": "The recurring investment amount.",
      "example": "example-value"
    },
    "currency": {
      "type": "string",
      "description": "The currency as an ISO 4217 code.",
      "pattern": "^[A-Z]{3}$",
      "example": "EUR"
    },
    "frequency": {
      "type": "string",
      "enum": [
        "WEEKLY",
        "BIWEEKLY",
        "MONTHLY",
        "QUARTERLY"
      ],
      "description": "The execution frequency.",
      "example": "WEEKLY"
    }
  },
  "required": [
    "account_id",
    "cash_amount",
    "currency",
    "frequency"
  ]
}