Assign or create a recurring series

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.

Assign or create a recurring series

cURL

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>"
  ]
}
'

import requests

url = "https://breadbox.example.com/api/v1/series"

payload = {
    "series_id": "<string>",
    "series_name": "<string>",
    "create_if_missing": True,
    "transaction_ids": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    series_id: '<string>',
    series_name: '<string>',
    create_if_missing: true,
    transaction_ids: ['<string>']
  })
};

fetch('https://breadbox.example.com/api/v1/series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://breadbox.example.com/api/v1/series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'series_id' => '<string>',
    'series_name' => '<string>',
    'create_if_missing' => true,
    'transaction_ids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://breadbox.example.com/api/v1/series"

	payload := strings.NewReader("{\n  \"series_id\": \"<string>\",\n  \"series_name\": \"<string>\",\n  \"create_if_missing\": true,\n  \"transaction_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://breadbox.example.com/api/v1/series")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"series_id\": \"<string>\",\n  \"series_name\": \"<string>\",\n  \"create_if_missing\": true,\n  \"transaction_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://breadbox.example.com/api/v1/series")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"series_id\": \"<string>\",\n  \"series_name\": \"<string>\",\n  \"create_if_missing\": true,\n  \"transaction_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "short_id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key · string · header · required

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

application/json

series_id · string

Existing series short ID or UUID to assign to.

series_name · string

Name to mint/resolve a series under (requires create_if_missing).

create_if_missing · boolean

type · enum<string>

Optional type for a minted series (default subscription).

Available options: subscription, bill, loan, other

transaction_ids · string[]

Maximum array length: 50

Response

200

application/json

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.

id · string

short_id · string

name · string

type · string

Recurring-charge type: subscription|bill|loan|other.

created_at · string<date-time>

updated_at · string<date-time>