ChoEsim Partner API: changelog

Newest entries first. Dates use the format YYYY-MM-DD.

2026-11-06: v1

Status: available to approved partners. Initial release of /partner/v1.

Endpoints

• Account: GET /me
• Catalogue: GET /plans, GET /plans/{plan_id}, POST /quotes
• Orders: POST /orders, GET /orders, GET /orders/{order_id}, POST /orders/{order_id}/cancel
• eSIMs: GET /esims/{esim_id}, GET /esims/{esim_id}/usage
• Wallet: GET /wallet, GET /wallet/entries
• Events and webhooks: GET /events, POST /events/{event_id}/resend, GET and POST /webhook-endpoints, DELETE /webhook-endpoints/{endpoint_id}, POST /webhook-endpoints/{endpoint_id}/rotate-secret
• Sandbox: POST /sandbox/wallet/topup (test keys only, needs orders:write)

Webhook events: order.fulfilled, order.failed, order.cancelled, order.delayed, esim.status_changed, wallet.credited, wallet.low_balance, ping.

Main rules

• Bearer API keys, with scopes and an optional IP allow-list.
• Idempotency-Key required for creating and cancelling orders. A replay returns the current state of the order, and the status code follows that state.
• Errors in RFC 9457 application/problem+json with a stable code. Error codes include cancel_window_expired, cancel_limit_exceeded and wallet_frozen.
• Cancellation window (cancel_window_days, default 14) and daily cancellation cap (daily_cancel_cap, default 5), both returned by GET /me.
• Amounts in USD cents.
• Fixed-data plans only. Up to 30 eSIMs per order.
• Webhooks signed in the Standard Webhooks style. The spec includes a test vector.

Versioning policy

• The major version is in the URL path (/partner/v1).
• Not breaking: new fields, new endpoints, new values in output enums (including new error codes). Your client must ignore what it does not know.
• Breaking: removing or renaming a field, changing the meaning of a field, or stricter validation. These need a new major version.
• Webhook payloads carry api_version.

Deprecation policy

When ChoEsim deprecates a version or an endpoint:

1. Responses carry a Deprecation header and a Sunset header.
2. The change is described in this changelog.
3. ChoEsim writes to your contact address.
4. ChoEsim gives at least six months notice, except for urgent security, legal or abuse reasons.

Security fixes that do not break existing integrations ship without notice period and are listed here afterwards.