DRUO
Get started
Recurring Plans

Cancel Recurring Plan

PUThttps://api.druo.com/recurring-plans/{recurring_plan_uuid}/cancel

Cancels an active recurring plan.

Updates the status of a specific recurring plan to CANCELED, preventing any future payment cycles from being processed.

Path parameters

recurring_plan_uuidstringRequired

The unique identifier of the resource.

Response

uuidstringoptional

The unique identifier of the Recurring Plan.

Example: rcp_747536f4-1efd-4cad-91b3-cc8aaeed93e3
codestringoptional

The unique code of the Recurring Plan.

Example: SCSCDSVFGH
descriptionstringoptional

The description of the Recurring Plan.

Example: Recurring Plan #1234567 for transaction 123455
processing_methodstringoptional

The processing method used for the Recurring Plan.

Example: AUTOMATIC
statusstringoptional

The status of the Recurring Plan.

Example: CANCELED
start_datestringoptional

The scheduled start date and time of the Recurring Plan.

Example: 2023-08-16T23:20:15.645+00:00
end_datestringoptional

The scheduled end date and time of the Recurring Plan.

Example: 2023-10-16T23:20:15.645+00:00
total_cycle_countintegeroptional

The total number of cycles for the Recurring Plan.

Example: 4
cycle_frequencystringoptional

The frequency of the Recurring Plan cycles.

Example: MONTHLY
end_userEndUseroptional

The end user details associated with the Recurring Plan.

origin_accountstringoptional

The origin account associated with the Recurring Plan.

Example: acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340
destination_accountstringoptional

The destination account associated with the Recurring Plan.

Example: acc_7985e8a4-8f38-4eab-8b27-a5d1c6dbf340
primary_referencestringoptional

The primary reference used to associate the Recurring Plan with an external entity.

Example: 23423524
secondary_referencestringoptional

The secondary reference used to associate the Recurring Plan with an external entity.

Example: bj39fhow39fhqp3f0hfae4344
transactionobjectoptional

The transaction details associated with the Recurring Plan.

metadataobjectoptional

A set of key-value pairs associated with the Recurring Plan.

Example: {"order_id": "6735"}
date_created_gmtstringoptional

The creation date and time of the Recurring Plan in GMT.

Example: 2021-11-15T23:23:38Z
date_updated_gmtstringoptional

The last update date and time of the Recurring Plan in GMT.

Example: 2021-11-15T23:23:38Z
NextGETGet Balance