Explain near-miss subscriptions
curl --request GET \
--url https://breadbox.example.com/api/v1/series/explain \
--header 'X-API-Key: <api-key>'{
"near_misses": [
{
"merchant_key": "<string>",
"name": "<string>",
"iso_currency_code": "<string>",
"occurrence_count": 123,
"qualifies": true,
"reason": "<string>",
"explanation": "<string>",
"nearest_cadence": "<string>",
"median_gap_days": 123,
"interval_cv": 123,
"amount_min": 123,
"amount_max": 123,
"amount_spread_ratio": 123,
"first_seen": "2023-12-25",
"last_seen": "2023-12-25"
}
]
}Answer "why isn't <merchant> a subscription?". Reports every recurring-looking merchant group that is not already a series, with the detector's verdict — `qualifies:true` (eligible but untracked) or a specific gate it failed (`too_few_occurrences`, `irregular_cadence`, `interval_too_variable`, `amount_unstable`, `same_day_duplicates`). Read-only analysis over the trailing detection window.
Explain near-miss subscriptions
curl --request GET \
--url https://breadbox.example.com/api/v1/series/explain \
--header 'X-API-Key: <api-key>'{
"near_misses": [
{
"merchant_key": "<string>",
"name": "<string>",
"iso_currency_code": "<string>",
"occurrence_count": 123,
"qualifies": true,
"reason": "<string>",
"explanation": "<string>",
"nearest_cadence": "<string>",
"median_gap_days": 123,
"interval_cv": 123,
"amount_min": 123,
"amount_max": 123,
"amount_spread_ratio": 123,
"first_seen": "2023-12-25",
"last_seen": "2023-12-25"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
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.
Response
200 - application/json
Near-miss merchant groups with detector verdicts.
Show child attributes
Show child attributes
Last modified on May 31, 2026
⌘I