Bitcall APIAdd your Key ID and Secret to send test requests.
Buy a plan
Buys a plan and begins provisioning. Returns immediately with an order to poll; delivery completes asynchronously.
Authorization
KeyId ApiSecret x-key-id<token>
Your API key id.
In: header
x-api-secret<token>
Your API key secret.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/esim/orders" \ -H "x-key-id: YOUR_KEY_ID" \ -H "x-api-secret: YOUR_API_SECRET" \ -H "Content-Type: application/json" \ -d '{ "planId": "pln_9OOXVUPmNmI_MPiVZuWLcO7Q-id5EJsV1fae-tZihg" }'{
"data": {
"orderId": "ord_EXAMPLE_order_00000000000000000000003",
"status": "delivered",
"price": {
"amount": 0.87,
"currency": "EUR"
},
"createdAt": "2026-09-15T23:28:43.997Z",
"updatedAt": "2026-09-15T23:28:44.797Z",
"esims": [
{
"iccid": "8944500102030405062",
"activationCode": "LPA:1$smdp.example.com$EXAMPLE-CODE-0003",
"network": "El Jem Communications"
}
]
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request is not valid. See `fields` for what to correct.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "AUTHENTICATION_REQUIRED",
"message": "This endpoint requires an API key.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "No such resource.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource is not in a state that allows this operation.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the interval in `Retry-After`.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Something went wrong on our side.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_RESPONSE_INVALID",
"message": "The upstream service returned an unexpected response.",
"requestId": "9f1c7b2e-…"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is temporarily unavailable. Try again shortly.",
"requestId": "9f1c7b2e-…"
}
}