Confirm, rename, re-time, re-price, stop, or dismiss a recurring series.

Confirm, rename, re-time, re-price, stop, or dismiss a recurring series. Any field on a candidate confirms inclusion in the schedule, including a deliberately selected variable payment; several ids may share one status-only change. Initial curation should favor predictable bills and subscriptions. Preserve existing agent placements rather than resetting them to automatic defaults.

post/v1/recurring/update

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/recurring/update
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

associate_fromstring

Explicitly associate this unconfirmed candidate with recurring_item_id, the existing curated series. Links its observed identity to the target without merging or deleting evidence groups. Payments must still meet the approved date and amount bounds. Preserves the target schedule or dismissal. Read possible_matches as evidence before confirming; no similarity match applies automatically.

recurring_item_idstring
recurring_item_idsstring[]

Several series for one status-only change, such as confirming every candidate at once.

status'active' | 'stopped' | 'dismissed'

active confirms inclusion in the schedule; stopped records that a real series ended; dismissed excludes a false or unsuitable schedule detection from the default list. Candidates already contribute nothing to commitment totals. Stopping or dismissing preserves transactions and does not cancel a payment. Any other field on a candidate also confirms it unless an explicit status is supplied. Re-read effective state after changing it.

merchant_namestring
cadence'weekly' | 'biweekly' | 'semimonthly' | 'monthly' | 'quarterly' | 'semiannual' | 'annual'

How often the series posts: weekly, biweekly, semimonthly, monthly, quarterly, semiannual, or annual.

amount_minstring

Inclusive minimum payment as Money text. Supply with amount_max for a variable bill; the range must contain amount. No percentage tolerance is inferred.

amount_maxstring

Inclusive maximum payment as Money text. Supply with amount_min in the series currency. Supplying amount alone resets matching to that exact amount.

amountstring

Money text in the series' own currency, such as "USD 13.00".

categorystring
next_expected_datestring date

Set the first date of the approved schedule. Later occurrences advance on this cadence even after early, late, or missed postings.

ends_atstring date nullable

The date a finite series ends; null clears it.

date_tolerance_daysinteger
approval_notestring

Why the series reads this way. Defaults to the action reason.

approval_sourcestring
set_bystring

Response

Envelope with each series as it now reads, plus next actions and any schedule warnings.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.