Cancel a savings plan

PATCH

/v1/savings-plan/{savings_plan_id}

This endpoint allows users to terminate an existing savings plan by submitting the unique identifier of the plan and the status canceled. This endpoint processes the cancellation request and provides back the successful cancellation of the plan and all its details.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Success Response

Body

🟠401

🟠403

🟠404

🟠405

🟠422

🔴500

🔴503

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://test.whitelabel.bitpanda.com/v1/savings-plan/1eda5f65-eb10-64ce-b872-0242ac12000b' \
--header 'bp-user-id: 5b2ca85b-0191-4e93-9165-413df4aa0c18' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "canceled"
}'

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,
        "status": "canceled",
        "id": "1ed55cc7-f413-69a4-88f6-5aa1a9244d15",
        "created_at": "2022-01-01T13:07:31+00:00"
    }
}

Search for savings plans

Cancel a savings plan V2