curl --request POST \
--url https://breadbox.example.com/api/v1/series/{id}/type \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"merchant_key": "<string>",
"cadence": "<string>",
"expected_amount": 123,
"iso_currency_code": "<string>",
"status": "<string>",
"type": "<string>",
"confidence": "<string>",
"detection_source": "<string>",
"last_amount": 123,
"last_seen_date": "2023-12-25",
"next_expected_date": "2023-12-25",
"renewal_health": "<string>",
"days_until_renewal": 123,
"occurrence_count": 123,
"detection_signals": {},
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
}Requires full_access scope. Overrides the series type (subscription|bill|loan|other). Sticky correction — re-detection won’t change it back.
curl --request POST \
--url https://breadbox.example.com/api/v1/series/{id}/type \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"merchant_key": "<string>",
"cadence": "<string>",
"expected_amount": 123,
"iso_currency_code": "<string>",
"status": "<string>",
"type": "<string>",
"confidence": "<string>",
"detection_source": "<string>",
"last_amount": 123,
"last_seen_date": "2023-12-25",
"next_expected_date": "2023-12-25",
"renewal_health": "<string>",
"days_until_renewal": 123,
"occurrence_count": 123,
"detection_signals": {},
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
Breadbox API key with format bb_<base62>. Carries either read_only
or full_access scope. Write endpoints (and a handful of sensitive
reads — /api-keys, /users/{user_id}/login) require full_access;
endpoints that require it are flagged in their description.
Path Parameters
Body
subscription, bill, loan, other Response
Updated series.
A detected recurring series (subscription).
weekly|biweekly|monthly|quarterly|semiannual|annual|irregular|unknown.
active|paused|cancelled|candidate.
Recurring-charge type: subscription|bill|loan|other. Inferred from the members' dominant category at first detection; user/agent-overridable + sticky.
auto|confirmed|rejected — the verdict axis.
deterministic|agent|user|rule.
Derived (active series only): active|due_soon|overdue|stale|unknown, from next_expected_date vs today.
Signed days to next_expected_date (negative = overdue). Omitted when no projection.