latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs

ledger

List Recurring Actions

get/api/v1/admin/ledger/recurring

status'active' | 'paused' | 'completed' | 'cancelled'

client_idstring nullable

token_idstring nullable

token_is_promotionalboolean nullable

Filter by Token.is_promotional

exclude_token_usage_scopestring nullable

Exclude tokens with this usage_scope

limitinteger

Successful Response

idstring uuid required

client_idstring uuid required

token_idstring uuid required

amount_per_occurrencestring required

recurrence_unit'day' | 'week' | 'month' | 'year' required

intervalinteger required

start_atstring date-time required

end_atstring date-time nullable

max_occurrencesinteger nullable

issued_countinteger

last_issued_atstring date-time nullable

next_occurrence_duestring date-time nullable

token_expires_daysinteger nullable

status'active' | 'paused' | 'completed' | 'cancelled' required

plan_idstring uuid nullable

created_bystring nullable

created_atstring date-time required

updated_atstring date-time nullable

meta_dataobject