Delete a recurring payment plan

POST

https://ssuccessv2.com/app/api/v2/payment/delete/:payment_recurring_id/recurring/payment-plan

Deletes selected failed, canceled, or scheduled payments from a recurring plan and then removes the plan.

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

payment_recurring_idintegerRequired

Recurring payment plan identifier.

This endpoint expects an object.

delete_scheduledboolean or nullOptional

delete_canceledboolean or nullOptional

delete_failedboolean or nullOptional

Recurring payment plan deleted successfully.

statusstringOptional

messagestringOptional

datalist of anyOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/payment/delete/901/recurring/payment-plan \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"delete_scheduled": true,
>	"delete_canceled": false,
>	"delete_failed": true
>	}'