Retrieving savings plans and plan executions

Prerequisites

In order to retrieve savings plans and savings plan executions, it is necessary to first create a savings plan.

→ List all savings plans

To list all savings plans, submit:

GET /savings_plans/

→ Retrieve an individual savings plan

You can retrieve an individual savings plan via:

GET /savings_plans/{savings_plan_id}

→ List all executions for a savings plan

You can list the executions for a savings plans with the following request:

GET /savings_plans/{savings_plan_id}/executions

Path parameter	Description
`savings_plan_id`	Required: Specify the ID of the savings plan that you want to retrieve.

→ Retrieve a specific execution by Id

To retrieve a single savings plan execution, submit the following request:

GET /savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}

Path parameter	Description
`savings_plan_id`	Required: Specify the ID of the savings plan that you want to retrieve.
`savings_plan_execution_id`	Required: Specify the ID of the savings plan execution that you want to retrieve.

Example response portfolio savings plan

{
  "id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
  "created_at": "2023-07-21T10:00:00.00Z",
  "type": "SAVINGS_PLAN_EXECUTION.NEW",
  "object": {
    "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4",
    "created_at": "2023-07-21T14:10:00.00Z",
    "updated_at": "2023-07-21T15:10:00.00Z",
    "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed",
    "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
    "savings_plan_id": "c31083c1-1cd3-405f-95d1-f49a37f0e032",
    "order_id": null,
    "cash_amount": "100",
    "currency": "EUR",
    "status": "NEW",
    "type": "PORTFOLIO",
    "execution_date": "2023-07-23"
  },
  "webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}