Cancel a savings plan

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.

SecuritybearerAuth
Request
path Parameters
savings_plan_id
required
string <uuid>

Savings plan id that needs to be canceled.

Example: 1eda5f65-eb10-64ce-b872-0242ac12000b
header Parameters
bp-user-id
required
string <uuid>

User id that savings plan belongs to.

Example: 5b2ca85b-0191-4e93-9165-413df4aa0c18
Request Body schema: application/json

Cancel a savings plan.

status
required
string

The new status of the savings plan. Only 'canceled' is accepted.(This will act as a confirmation)

Value: "canceled"
Responses
200

Success Response

401

Unauthorized

403

Forbidden

404

Not Found

405

Not Allowed

422

Validation Error

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

patch/v1/savings-plan/{savings_plan_id}
Request samples
application/json
{
  • "status": "canceled"
}
Response samples
application/json
{
  • "data": {
    }
}