v1

latestOpenAPI 3.0.02026-07-24231140.6 KB
Esims

Retrieve user esims.

get/esims

Query parameters

startinteger

Start index (Default: 0).

limitinteger

Maximum amount of returned records (Maximum/Default: 50).

afterstring

Start date for limiting results (Inclusive).

beforestring

End date for limiting results (Non-Inclusive).

Response

Success

Example response

{
  "meta": {
    "limit": 1,
    "after": "2021-10-04 00:00:00",
    "before": "2021-10-05 00:00:00",
    "_endpoint": "/esims"
  },
  "data": [
    {
      "rsp_url": "rsp-3104.idemia.io",
      "pin": "145G7-NW5BE-RU3TW-IDEMO",
      "barcode_value": "LPA:1$rsp-3104.idemia.io$145G7-NW5BE-RU3TW-IDEMO",
      "barcode_format": "QRCODE",
      "user_email": "user@example.com",
      "product": "bitrefill-esim-europe",
      "created_time": "2021-10-04T17:12:02.101Z",
      "access_token": "bitrefill-esim-europe",
      "package_history": [
        {
          "package_name": "1GB, 7 Days",
          "data_mb": 1000,
          "package_duration": 7,
          "country": "Europe",
          "order_id": "615b35e2f616a8092ee45aff",
          "purchase_time": "2021-10-04T17:12:02.101Z",
          "status": "expired",
          "initial_quantity": 1000000000,
          "remaining_quantity": 1000000000
        }
      ]
    }
  ]
}