API Versioning

Version header

Authpipe uses Stripe-style date-based versioning. Pass the version in the API-Version header:

API-Version: 2026-04-07

All SDKs send this header automatically:

// Node — defaults to 2026-04-07
const authpipe = new Authpipe({
  apiKey: "sk_...",
  apiVersion: "2026-04-07",
});

// Go — defaults to 2026-04-07
client := authpipe.NewClient("sk_...",
  authpipe.WithAPIVersion("2026-04-07"),
)

# Python — defaults to latest
client = Authpipe(api_key="sk_...", api_version="2026-04-07")

How it works

• Each API version is a date (e.g., 2026-04-07) representing a snapshot of the API’s behavior.
• When we make breaking changes, we release a new version date.
• Your requests are pinned to the version you specify.
• Omitting the header uses the workspace’s default version (set at creation time).

Breaking vs. non-breaking changes

Non-breaking (no version bump required):

• Adding new fields to responses
• Adding new endpoints
• Adding new optional parameters

Breaking (new version date):

• Removing or renaming fields
• Changing field types
• Changing default behavior
• Removing endpoints

Upgrading

To upgrade, change the API-Version header (or SDK apiVersion option) to the new date. Review the changelog for any breaking changes between your current version and the target version.