Delete pension

DELETE /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
Bearer auth

This endpoint allows users to delete a household pension.

Path parameters

  • HouseholdGUID string(uuid) Required

    The GUID of the household you wish to delete a pension for.

  • PensionGUID string(uuid) Required

    The GUID of the pension to delete.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
  • 404 application/json

    Pension not found

    Hide response attributes Show response attributes object
DELETE /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID} 
curl \
 -X DELETE https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/{PensionGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "message": "Pension deleted successfully"
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to edit the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Pension not found."
}