API Changelog

We use this page to announce additions, deprecations, and breaking
changes. Subscribe in ReadMe to receive notifications.

Versioning policy

• The path prefix /api/v1 indicates the major version. Breaking
  changes increment the major version and run alongside the previous
  major for at least 12 months.
• Additive changes (new endpoints, new optional fields, new error
  codes) do not require a version bump and ship continuously.
• Deprecations are announced here at least 90 days before
  removal, and the deprecated path/field is marked in the OpenAPI spec
  with deprecated: true.

What counts as breaking

Breaking change (requires major bump):

• Removing an endpoint, field, or enum value.
• Renaming a field or enum value.
• Changing a field's type or making an optional field required.
• Tightening validation in a way previously valid input is rejected.
• Removing or renaming an error.code.

Not breaking:

• Adding endpoints, fields, enum values, or error.codes.
• Loosening validation.
• Reordering JSON keys (clients must not depend on order).
• Changing error.message wording (clients must use error.code).

Recent changes

Populate this list as we ship. Maintained by hand on each release —
aim for one entry per merged PR that touches the public surface.

2026-06-03 — Subscription batch JSON uploads

• POST /api/v1/subscriptions/batch now accepts either a CSV file upload or
  an application/json body with rows.
• Exactly one input source is required; requests with both file and rows,
  or neither, return 400 Bad Request.
• PATCH /api/v1/subscriptions/batch/{batchUuid} replaces the rows on a
  correctable unprocessed batch and restarts validation.
• Batch processing now explicitly rejects any batch that contains non-valid
  rows, preventing partial processing.

2026-04-23 — Developer portal launch

• Initial public release on ReadMe.
• Published all partner, MVNO admin, and integration endpoints.
• Documented x-api-key and Bearer JWT auth schemes.