curl --request POST \
--url https://breadbox.example.com/api/v1/series \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"series_id": "<string>",
"merchant_key": "<string>",
"create_if_missing": true,
"name": "<string>",
"expected_amount": 123,
"currency": "<string>",
"category_id": "<string>",
"user_id": "<string>",
"transaction_ids": [
"<string>"
],
"confirm": true
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"merchant_key": "<string>",
"cadence": "<string>",
"expected_amount": 123,
"iso_currency_code": "<string>",
"status": "<string>",
"confidence": "<string>",
"detection_source": "<string>",
"last_amount": 123,
"last_seen_date": "2023-12-25",
"next_expected_date": "2023-12-25",
"occurrence_count": 123,
"detection_signals": {},
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
}Requires full_access scope. Create a series detection missed, or assign transactions to one. Provide series_id to assign to an existing series, or merchant_key + create_if_missing to mint one (funnels through the same dedup + sticky-reject arbitration as the detector). transaction_ids (max 50) are back-linked NULL-fill only. confirm:true activates the series in the same call.
curl --request POST \
--url https://breadbox.example.com/api/v1/series \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"series_id": "<string>",
"merchant_key": "<string>",
"create_if_missing": true,
"name": "<string>",
"expected_amount": 123,
"currency": "<string>",
"category_id": "<string>",
"user_id": "<string>",
"transaction_ids": [
"<string>"
],
"confirm": true
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"merchant_key": "<string>",
"cadence": "<string>",
"expected_amount": 123,
"iso_currency_code": "<string>",
"status": "<string>",
"confidence": "<string>",
"detection_source": "<string>",
"last_amount": 123,
"last_seen_date": "2023-12-25",
"next_expected_date": "2023-12-25",
"occurrence_count": 123,
"detection_signals": {},
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
}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.
Body
Existing series short ID or UUID to assign to.
Key to mint a new series under (requires create_if_missing).
weekly, biweekly, monthly, quarterly, semiannual, annual 50Response
Created or updated series.
A detected recurring series (subscription).
weekly|biweekly|monthly|quarterly|semiannual|annual|irregular|unknown.
active|paused|cancelled|candidate.
auto|confirmed|rejected — the verdict axis.
deterministic|agent|user|rule.