[FEAT] Implement API Endpoint to DELETE Subscription Plans: By Admin

[thenoblet]

Description

Implement the endpoint to delete a specific plan. This feature will enable administrators to manage existing subscription plans by allowing them to delete plans as necessary.

Purpose

• To allow administrators to delete a specific plan by its ID.

Acceptance Criteria

Delete Plan

• Delete a specific plan by its ID.
• Ensure authentication and authorization mechanisms for administrators.
• Return a success message upon successful deletion.
• Proper error handling for scenarios where the plan does not exist or deletion fails.

Requirements

Delete Plan

• Delete a specific plan by its ID.
• Ensure request is from authorized and authenticated admin.
• Return a success message upon successful deletion.
• Proper error handling for scenarios where the plan does not exist or deletion fails.

Expected Outcome

• An endpoint to delete a plan.
• Appropriate success and error responses for the endpoint.

Checklist

1. Delete Plan

   • [ ] Implement DELETE /api/v1/plans/{id} endpoint
   • [ ] Validate plan ID
   • [ ] Secure endpoint with authentication and authorization for administrators.
   • [ ] Handle and return errors

Testing

• [ ] Write unit and integration tests for the endpoint
• [ ] Test successful delete operations.
• [ ] Test edge cases and error scenarios thoroughly.

Documentation

• [ ] Document the endpoint, including request and response formats.
• [ ] Include information on error handling and possible scenarios.

Endpoint

Delete Plan

Description: Delete a specific plan.
Endpoint: DELETE /api/v1/plans/{id}
Authentication: Required
Authorization: Administrators only
Response (Success):

{
  "message": "Plan deleted successfully.",
  "status_code": 200
}

Response (Error: General Failure):

{
  "message": "Failed to delete plan.",
  "status_code": 500
}

Response (Error: Plan Not Found):

{
  "message": "Plan not found.",
  "status_code": 404
}

[thenoblet]

Hello Mentors, this issue complements the existing issue [FEAT] Implement API Endpoints for Creating Subscription Plans. and [FEAT]: Organization Billing Plans - Retrieve Plans for Super Admin and Owners. While the existing issues focuses on CREATING and RETRIEVING subscription plans, my issue addresses the endpoint required for DELETING those subscription plans.

The goal is to complete the suite of CRUD operations for subscription plans, ensuring a comprehensive API that covers all necessary interactions with subscription data.

[phurhard]

Update your response to follow the given criteria

[thenoblet]

Update your response to follow the given criteria

@phurhard I have updated it. Using the snake_case now.

[highb33kay]

This is 3 endpoints? @phurhard

I think this should be separated into three tickets to allow better tracking

@thenoblet

[thenoblet]

This is 3 endpoints? @phurhard

I think this should be separated into three tickets to allow better tracking

@thenoblet

@phurhard, 2 endpoints please. To retrieve and delete a subscription plan. Do I need to break them into separate endpoints? @highb33kay

[highb33kay]

Yes, you do. Two tickets for easier tracking by PMS

[highb33kay]

Please create and attach second ticket here

[thenoblet]

@highb33kay and @phurhard, I found out that there is an issue for RETRIEVE already. So I edited this endpoint to handle the DELETE operation only.

Existing issue for RETRIEVE: [FEAT]: Organization Billing Plans - Retrieve Plans for Super Admin and Owners