Appearance

API versioning ​

Hosted Billing uses a pinned API version (Stripe-style) so official SDKs do not silently break when the HTTP contract evolves.

Current version ​

Version2026-01-01
Request headerAutlantic-Version: 2026-01-01
Response headerAutlantic-Version: 2026-01-01

If the request omits Autlantic-Version, the API uses 2026-01-01 (current default).

Unsupported values return 400 with a stable error body.

Official SDKs ​

Server SDKs send Autlantic-Version on every hosted request and pin to a version listed in their changelog. Upgrade the SDK (or pass an explicit version when the client supports it) to opt into newer behavior.

Compatibility policy ​

  • Additive changes (new optional fields, new endpoints) may ship on the current version.
  • Breaking changes require a new dated version and a deprecation window announced in the changelog.
  • OpenAPI at docs.autlantic.com/openapi.yaml describes the current default version.

Deprecation policy ​

When a dated API version is retired:

  1. Notice. Autlantic announces deprecation in the changelog with at least 90 days before the version stops being accepted.
  2. Migration. Merchants and SDKs should pin (or upgrade) to a supported Autlantic-Version before the end of the window.
  3. Unsupported requests. After removal, sending a retired or unknown Autlantic-Version returns HTTP 400 with a stable error body (for example code: unsupported_api_version when present). The request is not processed under a silent fallback version.

During the notice window, both the retiring version and newer supported versions continue to work unless the changelog states otherwise.

HeaderRole
Autlantic-VersionAPI contract pin (request + response)
Idempotency-KeySafe retries on POST creates
X-Autlantic-Client-Request-IdClient-generated id for support
x-request-id / x-autlantic-request-idServer request id when present
X-Autlantic-Sdk-VersionSDK package version (Node and other official clients)

When contacting support, include request_id, merchant id, Test or Live, and Autlantic-Version.