Search for savings plans

GET

/v1/savings-plan

List all savings plans with the possibility to filter by different identifiers like savings plan id, asset id, user id and status.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Success Response

Body

🟠401

🟠405

🟠422

🔴500

🔴503

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://test.whitelabel.bitpanda.com/v1/savings-plan?id=1eda5f65-eb10-64ce-b872-0242ac12000b&user_id=5b2ca85b-0191-4e93-9165-413df4aa0c18&asset_id=1&status=active&page_size=10&page=1' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "user_id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
            "fiat_id": 1,
            "asset_id": 1,
            "fiat_amount": "20.12",
            "frequency": "weekly",
            "day": 5,
            "next_recurrence": "2023-01-06T12:00:00+00:00",
            "notification_date": "2023-01-04",
            "status": "active",
            "id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
            "created_at": "2022-01-01T13:07:31+00:00"
        }
    ],
    "meta": {
        "total_count": 48,
        "page": 3,
        "page_size": 10
    },
    "links": {
        "first": "?page=1&page_size=10",
        "last": "?page=5&page_size=10",
        "prev": "?page=2&page_size=10",
        "next": "?page=4&page_size=10",
        "self": "?page=3&page_size=10"
    }
}

Create a savings plan

Cancel a savings plan