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>",
"series_name": "<string>",
"create_if_missing": true,
"transaction_ids": [
"<string>"
]
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Requires full_access scope. Link transactions to a series, creating it if needed. Provide series_id to assign to an existing series, or series_name + create_if_missing to mint/resolve one by name (surrogate-first: the same name always resolves the same series). transaction_ids (max 50) are back-linked NULL-fill only.
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>",
"series_name": "<string>",
"create_if_missing": true,
"transaction_ids": [
"<string>"
]
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_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.
Body
Existing series short ID or UUID to assign to.
Name to mint/resolve a series under (requires create_if_missing).
Optional type for a minted series (default subscription).
subscription, bill, loan, other 50Response
Created or updated series.
A thin, rule-maintained recurring series (subscription/bill/loan). Surrogate identity + name + type; membership comes from assign_series rules, not a shipped detector.