DRUO
Get started
Recurring Plans

List Recurring Plans

GEThttps://api.druo.com/recurring-plans/list

Retrieve a list of all recurring plans belonging to the business.

This endpoint retrieves a paginated list of recurring plans. It supports advanced filtering and search capabilities using query parameters.

Query parameters

pageintegeroptional

The page number to return. Starts at 1.

page_sizeintegeroptional

The number of items per page. Defaults to 1000 when omitted.

Pagination · Filters

Response— Returns a paginated list.

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 current status of the recurring plan.

Example: ACTIVE
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's cycles.

Example: MONTHLY
end_userEndUseroptional

The End User object associated with the recurring plan.

origin_accountstringoptional

The unique identifier of the origin account for the recurring plan.

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

The unique identifier of the destination account for the recurring plan.

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

The primary reference key used to associate the recurring plan with an external system entity.

Example: 23423524
secondary_referencestringoptional

The secondary reference key used to associate the recurring plan with an external system entity.

Example: bj39fhow39fhqp3f0hfae4344
transactionobjectoptional

The transaction configuration template for the recurring plan.

transaction.tenantobjectoptional

The tenant associated with the transaction.

The unique identifier of the tenant.

Example: 22637d15-5b37-4fb2-90e5-aa8751970469
transaction.typestringoptional

The transaction type (e.g., PAYMENT).

Example: PAYMENT
transaction.currencystringoptional

The currency code for the transaction.

Example: USD
transaction.amountintegeroptional

The transaction amount in cents.

Example: 10000

The statement descriptor displayed on bank statements.

Example: NOVO BILLING* INV12324

The primary reference of the transaction.

Example: Transaction primary reference

The secondary reference of the transaction.

Example: Transaction secondary reference
transaction.metadataobjectoptional

Metadata associated with the transaction.

Example: {"id_user": "69440", "transaction_xyz": "JOHN SMITH"}
metadataobjectoptional

Set of key-value pairs that you can attach to the recurring plan. Up to 50 keys are supported, with key names up to 40 characters and values up to 500 characters.

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
NextPUTActivate Recurring Plan