Versioning & changes
The API is versioned in the path. The current version is v1. We add capabilities additively so your integration keeps working.
The v1 path#
Every endpoint lives under /api/v1. A future breaking change would ship under a new prefix (/api/v2) — v1won't change shape underneath you.
What counts as non-breaking#
These changes can land in v1 at any time, so write tolerant clients:
- New fields on existing responses.
- New endpoints and new resources.
- New optional request fields and new enum values.
Unknown request fields are ignored, and you should ignore response fields you don't recognize rather than failing on them.
What's in v1 today#
- Clients — create, retrieve, list.
- Invoices — create (draft / issue / send), retrieve, list.
More resources (payments, payment links, plans) and scoped keys are on the roadmap and will arrive as additive v1 changes.