Versioning

The Partner API is versioned in the path (/v1). We add fields and endpoints without breaking you, and never remove or repurpose a field within a version.

Stability promise

  • Additive changes (new optional fields, endpoints, event types) can ship any time — tolerate unknown fields.

  • Breaking changes ship under a new version path; the old one keeps working during a deprecation window.

  • The machine-readable contract is always at /openapi.json.

Best practices

  • Parse defensively — ignore fields you don't recognise.

  • Pin to /v1 explicitly; don't assume a default.

  • Watch the changelog for additions.

Was this page helpful?