Bitcall logoBitcall API
Add your Key ID and Secret to send test requests.

List orders

GET
/v1/esim/orders

Returns your eSIM orders, newest first. Filter with status, using the same status names the orders themselves carry.

Authorization

KeyId ApiSecret
x-key-id<token>

Your API key id.

In: header

x-api-secret<token>

Your API key secret.

In: header

Query Parameters

page?integer
Default1
Range1 <= value <= 10000
pageSize?integer
Default50
Range1 <= value <= 200
status?string
Value in"pending" | "processing" | "delivered" | "refund_pending" | "refunded"
planId?string
Match^pln_[A-Za-z0-9_-]{20,128}$
region?string
Length1 <= length <= 64
sort?string
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/esim/orders?page=1&pageSize=50&status=pending&sort=asc" \  -H "x-key-id: YOUR_KEY_ID" \  -H "x-api-secret: YOUR_API_SECRET"
{
  "data": [
    {
      "orderId": "ord_EXAMPLE_order_00000000000000000000001",
      "status": "delivered",
      "price": {
        "amount": 0.87,
        "currency": "EUR"
      },
      "createdAt": "2026-09-15T23:19:06.693Z",
      "updatedAt": "2026-09-15T23:19:07.590Z",
      "esims": [
        {
          "iccid": "8944500102030405060",
          "activationCode": "LPA:1$smdp.example.com$EXAMPLE-CODE-0001",
          "network": "El Jem Communications"
        }
      ]
    },
    {
      "orderId": "ord_EXAMPLE_order_00000000000000000000002",
      "status": "delivered",
      "price": {
        "amount": 0.87,
        "currency": "EUR"
      },
      "createdAt": "2026-09-15T22:34:18.307Z",
      "updatedAt": "2026-09-15T22:34:19.129Z",
      "esims": [
        {
          "iccid": "8944500102030405061",
          "activationCode": "LPA:1$smdp.example.com$EXAMPLE-CODE-0002",
          "network": "El Jem Communications"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 2,
    "total": 20,
    "totalPages": 10,
    "hasNext": true
  }
}
{
  "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": "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-…"
  }
}