---
title: "List Recurring Actions"
method: GET
path: "/api/v1/admin/ledger/recurring"
tags: ["Admin APIs", "ledger"]
---

# List Recurring Actions

`GET /api/v1/admin/ledger/recurring`

## Query parameters

- `status` 'active' | 'paused' | 'completed' | 'cancelled'
- `client_id` string, nullable
- `token_id` string, nullable
- `token_is_promotional` boolean, nullable — Filter by Token.is_promotional
- `exclude_token_usage_scope` string, nullable — Exclude tokens with this usage_scope
- `limit` integer

## Response `200`

Successful Response

- ScheduledLedgerRecurringActionResponse[]
  - `id` string, uuid, required
  - `client_id` string, uuid, required
  - `token_id` string, uuid, required
  - `transaction_type` 'purchase' | 'consume' | 'promotion' | 'expiration' | 'adjustment' | 'marketplace'
  - `amount_per_occurrence` string, required
  - `recurrence_unit` 'day' | 'week' | 'month' | 'year', required
  - `interval` integer, required
  - `start_at` string, date-time, required
  - `end_at` string, date-time, nullable
  - `max_occurrences` integer, nullable
  - `issued_count` integer
  - `last_issued_at` string, date-time, nullable
  - `next_occurrence_due` string, date-time, nullable
  - `token_expires_days` integer, nullable
  - `status` 'active' | 'paused' | 'completed' | 'cancelled', required
  - `plan_id` string, uuid, nullable
  - `created_by` string, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable
  - `meta_data` object

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)