Skip to content

Guide

Versioning

How the ORN API is versioned: the /api/v1 surface, the API-PRICING-2.0 pricing register stamped on every call, and what changes mean for your integration.

API version

The current API surface is v1, expressed in the path of every operation: /api/v1/…. Within v1, changes are additive — new operations, new optional parameters, new fields in responses — and existing operations keep their contracts. Breaking changes (removing or renaming operations or parameters, changing response shapes incompatibly) will ship as a new version alongside v1, never inside it.

Pricing version

Prices live in their own register with its own version — API-PRICING-2.0 today. The register version that applied is stamped on every usage record, so your historical bills always match the prices that were in force when each call was made.

  • Price changes are announced in the changelog before they take effect.
  • The tier and price recorded at call time are never rewritten retroactively.

Deprecation policy

When an operation is eventually retired, it is announced in the changelog with a sunset timeline and continues to work until the announced date. Planned capabilities are labelled as planned in this documentation — the Notifications capability is registered today, for example, and its priced operations do not exist yet.