Upvest · JSON Structure

Investment Api Savings Plan Update Structure

Request body for updating a savings plan.

Type: object Properties: 3
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

SavingsPlanUpdate is a JSON Structure definition published by Upvest, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

cash_amount frequency status

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-update-structure.json",
  "name": "SavingsPlanUpdate",
  "description": "Request body for updating a savings plan.",
  "type": "object",
  "properties": {
    "cash_amount": {
      "type": "string",
      "description": "The updated investment amount.",
      "example": "example-value"
    },
    "frequency": {
      "type": "string",
      "enum": [
        "WEEKLY",
        "BIWEEKLY",
        "MONTHLY",
        "QUARTERLY"
      ],
      "description": "The updated execution frequency.",
      "example": "WEEKLY"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "PAUSED"
      ],
      "description": "Activate or pause the savings plan.",
      "example": "ACTIVE"
    }
  }
}