eSIMfx API

https://docs.esimfx.com
Admin
The eSIMfx API provides a robust suite of endpoints for integrating and managing global eSIM...
Tokens:10,229
Snippets:37
Trust Score:7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Get Order Details Response Example

Source: https://docs.esimfx.com/index

An example JSON response for the 'Get Order Details' API. It showcases the structure of the returned data, including order ID, product information, subscription details (like upper limit, used amount, activation time, expiry, and status), and overall order status.

```JSON
{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "01b47ffa-4a74-4209-87e2-d282e274xxxx",
    "iccid": "89440000000000000000",
    "product": {
      "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx",
      "name": "japan_10GB_7Day",
      "duration": 7,
      "duration_unit": "DAY",
      "imsi_profile": "Green"
    },
    "subscription": {
      "upper_limit_amount": 10737418240,
      "used_amount": 0,
      "amount_unit": "Byte",
      "activation_time": "2025-09-30T05:20:12Z",
      "expiry": "2025-10-07T05:20:12Z",
      "status": "PENDING",
      "activate_by": "2025-09-30T05:20:12Z"
    },
    "status": "COMPLETED",
    "creation_time": "2025-09-24T05:20:12Z"
  }
}
```

--------------------------------

### Check Available Top-Up Products Response Example

Source: https://docs.esimfx.com/index

An example JSON response for the 'Check Available Top-Up Products' API. It lists compatible top-up products, including their IDs, names, data amounts, validity periods, pricing, and network information. This data helps users select the appropriate top-up option.

```JSON
{
  "code": 0,
  "message": "Success",
  "data": {
    "products": [
      {
        "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx", 
        "name": "Japan_10GB_7Day", 
        "duration": 7, 
        "duration_unit": "DAY",
        "amount": 10, 
        "amount_unit": "GB", 
        "coverage": [  
        ],
        "networks": [ 
          {
            "mccmnc": "44020",
            "name": "SOFTBANK",
            "speed": "5G"
          },
          {
            "mccmnc": "44051",
            "name": "KDDI au",
            "speed": "5G"
          }
        ],
        "imsi_profile": "Green",
        "price": 12, 
        "price_unit": "USD"
        }
      }
    ]
  }
}
```

--------------------------------

### GET /product/api/v1/get_products

Source: https://docs.esimfx.com/index

Retrieves available eSIM packages. Supports filtering by countries and regions, and includes pagination parameters.

```APIDOC
## GET /product/api/v1/get_products

### Description
Retrieves a list of available eSIM products. This endpoint can be filtered by country and region. When both `countries` and `region` are provided, the `region` filter takes precedence. Pagination is supported using `page_start` and `page_size`. A `last_evaluated_key` in the response indicates the presence of subsequent pages.

### Method
GET

### Endpoint
`/product/api/v1/get_products`

### Query Parameters
- **countries** (string) - Optional - Filter products by country code (e.g., "JP").
- **region** (string) - Optional - Filter products by region. Takes precedence over `countries` if both are provided.
- **page_start** ({})
- **page_size** (integer) - Optional - The number of items to return per page. Defaults to 10.

### Request Example
```json
{
  "page_start": {},
  "page_size": 10,
  "countries": "JP"
}
```

### Response
#### Success Response (200)
- **code** (integer) - Response status code.
- **message** (string) - Response message.
- **data** (object) - Contains the list of products and pagination information.
  - **products** (array) - List of available eSIM products.
    - **id** (string) - Unique identifier for the product.
    - **name** (string) - Name of the eSIM package.
    - **duration** (integer) - Duration of the plan.
    - **duration_unit** (string) - Unit of the duration (e.g., "DAY").
    - **amount** (integer) - Data amount included in the plan.
    - **amount_unit** (string) - Unit of the data amount (e.g., "GB").
    - **coverage** (array) - List of country codes covered by the plan.
    - **networks** (array) - List of network providers for the eSIM.
      - **mccmnc** (string) - Mobile Country Code and Mobile Network Code.
      - **name** (string) - Name of the network provider.
      - **speed** (string) - Network speed (e.g., "5G").
    - **imsi_profile** (string) - IMSI profile identifier.
    - **price** (number) - Price of the plan.
    - **price_unit** (string) - Currency unit (e.g., "USD").
  - **last_evaluated_key** ({}) - Used for pagination; indicates the next page if present.

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "products": [
      {
        "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx",
        "name": "japan_10GB_7Day",
        "duration": 7,
        "duration_unit": "DAY",
        "amount": 10,
        "amount_unit": "GB",
        "coverage": [
          "JP"
        ],
        "networks": [
          {
            "mccmnc": "44020",
            "name": "SOFTBANK",
            "speed": "5G"
          },
          {
            "mccmnc": "44051",
            "name": "KDDI au",
            "speed": "5G"
          }
        ],
        "imsi_profile": "Green",
        "price": 12,
        "price_unit": "USD"
      }
    ],
    "last_evaluated_key": {}
  }
}
```
```

--------------------------------

### GET /product/api/v1/get_available_topups

Source: https://docs.esimfx.com/index

Retrieves a list of available top-up products for a given eSIM or product ID. This is useful before creating a top-up order.

```APIDOC
## GET /product/api/v1/get_available_topups

### Description
Before creating a top-up order, it is recommended to call this endpoint to get a list of available top-up products. Only products with the same `imsi_profile` field in the same region or coverage can be topped up with each other.

The request should contain either `product_id` or `iccid`:
  * `product_id`: The current product ID in use.
  * `iccid`: The ICCID of the eSIM for which you want to top up.

The response will contain a list of all available products for the current `product_id` or `iccid`.

### Method
GET

### Endpoint
`/product/api/v1/get_available_topups`

### Parameters
#### Query Parameters
- **product_id** (string) - Optional - The ID of the current product.
- **iccid** (string) - Optional - The ICCID of the eSIM.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **message** (string) - A message indicating the success or failure of the request.
- **data** (object) - Contains the list of available top-up products:
  - **products** (array) - A list of available top-up products:
    - **id** (string) - The product ID.
    - **name** (string) - The name of the product.
    - **duration** (integer) - The duration of the plan.
    - **duration_unit** (string) - The unit of the duration (e.g., DAY).
    - **amount** (integer) - The data amount of the plan.
    - **amount_unit** (string) - The unit of the data amount (e.g., GB, MB).
    - **coverage** (array) - A list of coverage areas for the product.
    - **networks** (array) - A list of network details:
      - **mccmnc** (string) - The MCCMNC code of the network.
      - **name** (string) - The name of the network.
      - **speed** (string) - The network speed (e.g., 5G).
    - **imsi_profile** (string) - The IMSI profile associated with the product.
    - **price** (integer) - The price of the top-up.
    - **price_unit** (string) - The currency unit of the price (e.g., USD).

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "products": [
      {
        "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx", 
        "name": "Japan_10GB_7Day", 
        "duration": 7, 
        "duration_unit": "DAY",
        "amount": 10, 
        "amount_unit": "GB", 
        "coverage": [],
        "networks": [
          {
            "mccmnc": "44020",
            "name": "SOFTBANK",
            "speed": "5G"
          },
          {
            "mccmnc": "44051",
            "name": "KDDI au",
            "speed": "5G"
          }
        ],
        "imsi_profile": "Green",
        "price": 12, 
        "price_unit": "USD"
      }
    ]
  }
}
```
```

--------------------------------

### GET /order/api/v1/get_esim_status

Source: https://docs.esimfx.com/index

Retrieves the current status of an eSIM using its ICCID.

```APIDOC
## GET /order/api/v1/get_esim_status

### Description
Retrieves the status of an eSIM identified by its ICCID. Common statuses include "Provisioned", "Active", "Expired", and "Blocked".

### Method
GET

### Endpoint
`/order/api/v1/get_esim_status`

### Query Parameters
- **iccid** (string) - Required - The ICCID of the eSIM to check.

### Request Example
```
/order/api/v1/get_esim_status?iccid=89440000000000000000
```

### Response
#### Success Response (200)
- **code** (integer) - Response status code.
- **message** (string) - Response message.
- **data** (object) - Contains eSIM status details.
  - **iccid** (string) - The ICCID of the eSIM.
  - **esim_qr** (string) - LPA activation information for the eSIM.
  - **status** (string) - The current status of the eSIM (e.g., "PROVISIONED", "ACTIVE", "EXPIRED", "BLOCKED").

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "iccid": "89440000000000000000",
    "esim_qr": "LPA:1$rsp.truphone.com$JQ-2D1JE2-XXXXXX",
    "status": "PROVISIONED"
  }
}
```
```

--------------------------------

### GET /order/api/v1/get_order

Source: https://docs.esimfx.com/index

Retrieves detailed information about a specific order, including subscription status, data usage, and expiry details.

```APIDOC
## GET /order/api/v1/get_order

### Description
This API is used to get order details by order id. You can know the real time subscription status as below:
  * **Subscription Upper Limit Amount:** Amount of data allocated to the subscription.
  * **Subscription Used Amount:** Amount of data consumed by the end user to-date.
  * **Subscription Amount Unit:** This is the unit measure of data, typically GB, but may also be MB, and for Unlimited Plans would be Days.
  * **Subscription Activation Time:** Timestamp (in UTC) when the eSIM first connected to an eligible network in the destination country.
  * **Subscription Expiry:**
    * For an eSIM whose subscription has not yet been activated: Timestamp (in UTC) when the eSIM is set to expire after order creation.
    * For an eSIM whose subscription has been activated: Timestamp (in UTC) when the subscription is set to expire, which should equal Activation Time + Package Validity.
    * For an eSIM whose subscription has already expired: Timestamp (in UTC) when the subscription expired.
  * **Subscription Status:** You will see 1 of 4 values on each Subscription:
    * **Pending:** This status means that the data plan is not yet activated.
    * **Active:** This status indicates that the data plan has been activated. Activation occurs when the eSIM connects to an eligible network at the destination or within 60 days from activation irrespective of the device being in the destination country or not (whichever comes first).
    * **Expired:** This status indicates that the data plan has expired naturally.
    * **Terminated:** This status indicates the data plan was terminated manually.

### Method
GET

### Endpoint
`/order/api/v1/get_order`

### Parameters
#### Query Parameters
- **order_id** (string) - Required - The ID of the order to retrieve.

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **message** (string) - A message indicating the success or failure of the request.
- **data** (object) - Contains the order details:
  - **id** (string) - The order ID.
  - **iccid** (string) - The ICCID of the eSIM.
  - **product** (object) - Details about the product associated with the order.
    - **id** (string) - The product ID.
    - **name** (string) - The name of the product.
    - **duration** (integer) - The duration of the plan.
    - **duration_unit** (string) - The unit of the duration (e.g., DAY).
    - **imsi_profile** (string) - The IMSI profile associated with the product.
  - **subscription** (object) - Details about the eSIM subscription.
    - **upper_limit_amount** (integer) - The total data limit for the subscription.
    - **used_amount** (integer) - The amount of data used so far.
    - **amount_unit** (string) - The unit of the data amount (e.g., Byte, GB).
    - **activation_time** (string) - The timestamp when the subscription was activated (UTC).
    - **expiry** (string) - The timestamp when the subscription expires (UTC).
    - **status** (string) - The current status of the subscription (Pending, Active, Expired, Terminated).
    - **activate_by** (string) - The timestamp by which the subscription should be activated (UTC).
  - **status** (string) - The overall status of the order.
  - **creation_time** (string) - The timestamp when the order was created (UTC).

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "01b47ffa-4a74-4209-87e2-d282e274xxxx",
    "iccid": "89440000000000000000",
    "product": {
      "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx",
      "name": "japan_10GB_7Day",
      "duration": 7,
      "duration_unit": "DAY",
      "imsi_profile": "Green"
    },
    "subscription": {
      "upper_limit_amount": 10737418240,
      "used_amount": 0,
      "amount_unit": "Byte",
      "activation_time": "2025-09-30T05:20:12Z",
      "expiry": "2025-10-07T05:20:12Z",
      "status": "PENDING",
      "activate_by": "2025-09-30T05:20:12Z"
    },
    "status": "COMPLETED",
    "creation_time": "2025-09-24T05:20:12Z"
  }
}
```
```

--------------------------------

### Get Order Details by Order ID

Source: https://docs.esimfx.com/index

Retrieves detailed information about an order, including subscription status, data usage, and expiry. This API is crucial for understanding the current state of an eSIM subscription. It requires an order ID as a parameter.

```HTTP
GET /order/api/v1/get_order?order_id=ab9b30e5-4c83-49f8-bc12-e7c1a84cxxxx
```

--------------------------------

### Check Available Top-Up Products

Source: https://docs.esimfx.com/index

Fetches a list of available top-up products for a given eSIM or product ID. This is essential before creating a top-up order to ensure compatibility based on 'imsi_profile' and region/coverage. The request requires either 'product_id' or 'iccid'.

```HTTP
GET /product/api/v1/get_available_topups?product_id=ca7e9da3-ca97-47cc-9d40-a77610c2xxxx&iccid=89440000000000000000
```

--------------------------------

### Browse Available eSIM Packages for Japan

Source: https://docs.esimfx.com/index

This API retrieves available eSIM products, allowing filtering by country and region. It supports pagination using `page_start` and `page_size`. The response includes product details such as ID, name, data allowance, duration, and price.

```json
{
  "page_start": {},
  "page_size": 10,
  "countries": "JP"
}
```

--------------------------------

### Create eSIM Order and Assign Subscription

Source: https://docs.esimfx.com/index

This API is used to create a new order for an eSIM. It requires the `operation_type` to be 'NEW' and the `product.id` of the desired eSIM package. Upon successful creation, it allocates a new eSIM and binds a subscription, returning order and subscription details.

```json
{
  "operation_type": "NEW",
  "product": {
    "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx"
  }
}
```

--------------------------------

### POST /order/api/v1/create_order

Source: https://docs.esimfx.com/index

Creates a new order for an eSIM product. Requires `operation_type` and `product.id`.

```APIDOC
## POST /order/api/v1/create_order

### Description
Creates a new order or a top-up order. To create a new order and allocate a new eSIM, set `operation_type` to "NEW" and provide the `product.id`.

### Method
POST

### Endpoint
`/order/api/v1/create_order`

### Request Body
- **operation_type** (string) - Required - Type of operation, "NEW" for a new order.
- **product** (object) - Required - Contains product details.
  - **id** (string) - Required - The ID of the product to order.

### Request Example
```json
{
  "operation_type": "NEW",
  "product": {
    "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx"
  }
}
```

### Response
#### Success Response (200)
- **code** (integer) - Response status code.
- **message** (string) - Response message.
- **data** (object) - Contains order and subscription details.
  - **id** (string) - Unique identifier for the order.
  - **status** (string) - Status of the order (e.g., "COMPLETED").
  - **subscription** (object) - Details of the eSIM subscription.
    - **upper_limit_amount** (integer) - Total data limit.
    - **amount_unit** (string) - Unit for the data limit (e.g., "Byte").
    - **status** (string) - Status of the subscription (e.g., "PENDING").
    - **activation_time** (string) - Timestamp when the subscription is activated.
    - **expiry** (string) - Timestamp when the subscription expires.
    - **activate_by** (string) - Deadline for activation.
  - **creation_time** (string) - Timestamp when the order was created.
  - **esim** (object) - Details of the provisioned eSIM.
    - **iccid** (string) - ICCID of the purchased eSIM.
    - **esim_qr** (string) - LPA activation information for the eSIM.
    - **status** (string) - Status of the eSIM (e.g., "PROVISIONED").

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "01b47ffa-4a74-4209-87e2-d282e274xxxx",
    "status": "COMPLETED",
    "subscription": {
      "upper_limit_amount": 10737418240,
      "amount_unit": "Byte",
      "status": "PENDING",
      "activation_time": "2025-09-30T03:07:11Z",
      "expiry": "2025-10-07T03:07:11Z",
      "activate_by": "2025-09-30T03:07:11Z"
    },
    "creation_time": "2025-08-01T03:07:11Z",
    "esim": {
      "iccid": "89440000000000000000",
      "esim_qr": "LPA:1$rsp.truphone.com$JQ-2D51JC-XXXXXX",
      "status": "PROVISIONED"
    }
  }
}
```
```

--------------------------------

### Create Top Up Order Request - JSON

Source: https://docs.esimfx.com/index

This JSON object represents a request to create a top-up order for an existing eSIM. It requires the operation type, the eSIM's ICCID, and the product ID of the desired top-up package. The 'TOPUP' operation type signifies adding data to an existing plan.

```json
{
  "operation_type": "TOPUP", 
  "iccid" : "89440000000000000000", 
  "product": {
    "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx"
  }
}
```

--------------------------------

### Orders API

Source: https://docs.esimfx.com/index

Create orders, automatically provision eSIMs, and bind data packages to them in a single, streamlined process. The API supports idempotent requests to ensure reliable order processing.

```APIDOC
## POST /orders

### Description
Creates a new order for an eSIM, including provisioning and data package assignment.

### Method
POST

### Endpoint
/orders

### Parameters
#### Request Body
- **productId** (string) - Required - The ID of the product to order.
- **iccid** (string) - Optional - The ICCID of the eSIM to assign. If not provided, a new eSIM will be provisioned.
- **customerId** (string) - Optional - Identifier for the end customer.
- **idempotencyKey** (string) - Optional - A unique key to ensure the request is processed only once.

### Request Example
```json
{
  "productId": "prod_123abc",
  "iccid": "89012345678901234567890",
  "customerId": "user_xyz789",
  "idempotencyKey": "unique-request-id-12345"
}
```

### Response
#### Success Response (200)
- **orderId** (string) - The unique identifier for the created order.
- **status** (string) - The current status of the order (e.g., "processing", "completed").
- **esim** (object) - Details about the provisioned eSIM.
  - **iccid** (string) - The ICCID of the eSIM.
  - **activationCode** (string) - The activation code for the eSIM (e.g., SM-DP+ Address and Activation Code).

#### Response Example
```json
{
  "orderId": "ord_987zyx",
  "status": "completed",
  "esim": {
    "iccid": "89012345678901234567890",
    "activationCode": "SMDP:XYZ123ABC;20230101120000;YOUR_ACTIVATION_CODE"
  }
}
```
```

```APIDOC
## GET /orders/{orderId}

### Description
Retrieves the details of a specific order.

### Method
GET

### Endpoint
/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The ID of the order to retrieve.

### Response
#### Success Response (200)
- **orderId** (string) - The unique identifier for the order.
- **status** (string) - The current status of the order.
- **productId** (string) - The ID of the product ordered.
- **esim** (object) - Details about the associated eSIM.
  - **iccid** (string) - The ICCID of the eSIM.
  - **activationCode** (string) - The activation code for the eSIM.

#### Response Example
```json
{
  "orderId": "ord_987zyx",
  "status": "completed",
  "productId": "prod_123abc",
  "esim": {
    "iccid": "89012345678901234567890",
    "activationCode": "SMDP:XYZ123ABC;20230101120000;YOUR_ACTIVATION_CODE"
  }
}
```
```

--------------------------------

### POST /order/api/v1/create_order

Source: https://docs.esimfx.com/index

Creates a top-up order for an existing eSIM. This endpoint allows users to select from available top-up packages and apply them to their eSIM.

```APIDOC
## POST /order/api/v1/create_order

### Description
This API is used to create a top-up order for an existing eSIM. You can select from available Top Up packages and apply them to your eSIM.

### Method
POST

### Endpoint
/order/api/v1/create_order

### Parameters
#### Request Body
- **operation_type** (string) - Required - Specifies the type of operation, should be "TOPUP" for top-up orders.
- **iccid** (string) - Required - The ICCID of the existing eSIM to which the top-up will be applied.
- **product** (object) - Required - An object containing details of the selected product.
  - **id** (string) - Required - The unique identifier of the selected top-up product.

### Request Example
```json
{
  "operation_type": "TOPUP", 
  "iccid" : "89440000000000000000", 
  "product": {
    "id": "ca7e9da3-ca97-47cc-9d40-a77610c2xxxx"
  }
}
```

### Response
#### Success Response (200)
- **code** (integer) - Indicates the success of the operation (0 for success).
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains details of the created order.
  - **id** (string) - The unique identifier for the order.
  - **status** (string) - The current status of the order (e.g., "COMPLETED").
  - **subscription** (object) - Details about the subscription associated with the order.
    - **upper_limit_amount** (integer) - The upper limit of the data allowance in bytes.
    - **amount_unit** (string) - The unit for the data amount (e.g., "Byte").
    - **status** (string) - The status of the subscription (e.g., "PENDING").
    - **activation_time** (string) - The date and time when the subscription was activated.
    - **expiry** (string) - The date and time when the subscription expires.
    - **activate_by** (string) - The date and time by which the subscription should be activated.
  - **creation_time** (string) - The date and time when the order was created.
  - **esim** (object) - Details about the eSIM associated with the order.
    - **iccid** (string) - The ICCID of the purchased eSIM.
    - **esim_qr** (string) - The LPA activation information for the eSIM.
    - **status** (string) - The current status of the eSIM (e.g., "ACTIVE").

#### Response Example
```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "13bd78f-4a74-4873-87e2-d234y475xxxx",
    "status": "COMPLETED",
    "subscription": {
      "upper_limit_amount": 10737418240,
      "amount_unit": "Byte",
      "status": "PENDING",
      "activation_time": "2025-10-08T03:07:11Z",
      "expiry": "2025-10-14T03:07:11Z",
      "activate_by": "2025-10-08T03:07:11Z"
    },
    "creation_time": "2025-08-01T03:07:11Z",
    "esim": {
      "iccid": "89440000000000000000",
      "esim_qr": "LPA:1$rsp.truphone.com$JQ-2D51JC-XXXXXX",
      "status": "ACTIVE"
    }
  }
}
```
```

--------------------------------

### Create Top Up Order Response - JSON

Source: https://docs.esimfx.com/index

This JSON object details the successful response from the create_order API for a top-up operation. It includes the order ID, status, subscription details, and information about the associated eSIM, such as its ICCID and activation details.

```json
{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "13bd78f-4a74-4873-87e2-d234y475xxxx", 
    "status": "COMPLETED",
    "subscription": {
      "upper_limit_amount": 10737418240, 
      "amount_unit": "Byte", 
      "status": "PENDING", 
      "activation_time": "2025-10-08T03:07:11Z", 
      "expiry": "2025-10-14T03:07:11Z", 
      "activate_by": "2025-10-08T03:07:11Z"
    },
    "creation_time": "2025-08-01T03:07:11Z",
    "esim": {
      "iccid": "89440000000000000000", 
      "esim_qr": "LPA:1$rsp.truphone.com$JQ-2D51JC-XXXXXX", 
      "status": "ACTIVE"
      }
  }
}
```

--------------------------------

### Product & Catalogue Management

Source: https://docs.esimfx.com/index

Access a global catalogue of eSIM data plans and top-up products to build your offerings.

```APIDOC
## GET /products

### Description
Retrieves a list of available eSIM data plans and top-up products.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **destination** (string) - Optional - Filter products by destination country code (e.g., "JP" for Japan).
- **type** (string) - Optional - Filter by product type (e.g., "data_plan", "top_up").

### Response
#### Success Response (200)
- **products** (array) - A list of available products.
  - **id** (string) - Unique identifier for the product.
  - **name** (string) - Name of the data plan or top-up.
  - **description** (string) - Detailed description of the product.
  - **price** (object) - Pricing information.
    - **amount** (number) - The price amount.
    - **currency** (string) - The currency code (e.g., "USD").
  - **dataAllowances** (object) - Details about the data allowance.
    - **value** (integer) - The data amount.
    - **unit** (string) - The unit of data (e.g., "GB").
  - **validity** (object) - Duration of the plan.
    - **value** (integer) - The validity period.
    - **unit** (string) - The unit of validity (e.g., "days").

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_123abc",
      "name": "Japan 7-Day 5GB Data Plan",
      "description": "Stay connected in Japan for 7 days with 5GB of high-speed data.",
      "price": {
        "amount": 25.00,
        "currency": "USD"
      },
      "dataAllowances": {
        "value": 5,
        "unit": "GB"
      },
      "validity": {
        "value": 7,
        "unit": "days"
      }
    }
  ]
}
```
```

--------------------------------

### Authentication & Profile Management

Source: https://docs.esimfx.com/index

Securely authenticate your application and retrieve your reseller profile details using your client ID and key.

```APIDOC
## POST /account/api/v1/auth

### Description
Authenticates with the eSIMfx API using client credentials to obtain an API Access Token.

### Method
POST

### Endpoint
/account/api/v1/auth

### Parameters
#### Request Body
- **clientId** (string) - Required - Your unique client identifier.
- **clientKey** (string) - Required - Your secret client key for authentication.

### Request Example
```json
{
  "clientId": "YOUR_CLIENT_ID",
  "clientKey": "YOUR_CLIENT_KEY"
}
```

### Response
#### Success Response (200)
- **accessToken** (string) - The token used for authenticating subsequent API requests.
- **expiresIn** (integer) - The duration in seconds until the token expires.

#### Response Example
```json
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 3600
}
```
```

--------------------------------

### Active eSIM Lifecycle Control

Source: https://docs.esimfx.com/index

Manage subscriptions post-activation with capabilities to activate, terminate, or block eSIMs based on your business rules.

```APIDOC
## POST /esims/{iccid}/activate

### Description
Activates an eSIM associated with the provided ICCID.

### Method
POST

### Endpoint
/esims/{iccid}/activate

### Parameters
#### Path Parameters
- **iccid** (string) - Required - The ICCID of the eSIM to activate.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the eSIM has been activated.

#### Response Example
```json
{
  "message": "eSIM with ICCID 89012345678901234567890 has been activated successfully."
}
```
```

```APIDOC
## POST /esims/{iccid}/terminate

### Description
Terminates an active eSIM subscription associated with the provided ICCID.

### Method
POST

### Endpoint
/esims/{iccid}/terminate

### Parameters
#### Path Parameters
- **iccid** (string) - Required - The ICCID of the eSIM to terminate.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the eSIM subscription has been terminated.

#### Response Example
```json
{
  "message": "eSIM subscription with ICCID 89012345678901234567890 has been terminated."
}
```
```

```APIDOC
## POST /esims/{iccid}/block

### Description
Blocks an eSIM associated with the provided ICCID, preventing further usage.

### Method
POST

### Endpoint
/esims/{iccid}/block

### Parameters
#### Path Parameters
- **iccid** (string) - Required - The ICCID of the eSIM to block.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the eSIM has been blocked.

#### Response Example
```json
{
  "message": "eSIM with ICCID 89012345678901234567890 has been blocked."
}
```
```

--------------------------------

### Check Current eSIM Status by ICCID

Source: https://docs.esimfx.com/index

This API retrieves the current status of an eSIM using its ICCID. Common statuses include Provisioned, Active, Expired, and Blocked. The response provides the ICCID, activation information (esim_qr), and the current status.

```http
GET /order/api/v1/get_esim_status?iccid=89440000000000000000
```

--------------------------------

### Reporting & Monitoring

Source: https://docs.esimfx.com/index

Retrieve detailed information on orders, check the status of individual eSIMs, and view all orders associated with a specific eSIM for full visibility.

```APIDOC
## GET /esims/{iccid}/status

### Description
Retrieves the current status and data usage information for a specific eSIM.

### Method
GET

### Endpoint
/esims/{iccid}/status

### Parameters
#### Path Parameters
- **iccid** (string) - Required - The ICCID of the eSIM to check.

### Response
#### Success Response (200)
- **iccid** (string) - The ICCID of the eSIM.
- **status** (string) - The current status of the eSIM (e.g., "active", "inactive", "suspended").
- **dataUsage** (object) - Information about data consumption.
  - **used** (number) - Data used so far.
  - **total** (number) - Total data allowance.
  - **unit** (string) - The unit of data (e.g., "GB").
- **validUntil** (string) - The expiration date of the current plan.

#### Response Example
```json
{
  "iccid": "89012345678901234567890",
  "status": "active",
  "dataUsage": {
    "used": 2.5,
    "total": 5.0,
    "unit": "GB"
  },
  "validUntil": "2024-12-31T23:59:59Z"
}
```
```

```APIDOC
## GET /esims/{iccid}/orders

### Description
Retrieves a list of all orders associated with a specific eSIM.

### Method
GET

### Endpoint
/esims/{iccid}/orders

### Parameters
#### Path Parameters
- **iccid** (string) - Required - The ICCID of the eSIM for which to retrieve orders.

### Response
#### Success Response (200)
- **orders** (array) - A list of orders associated with the eSIM.
  - **orderId** (string) - The unique identifier for the order.
  - **productId** (string) - The ID of the product ordered.
  - **orderDate** (string) - The date and time the order was placed.
  - **status** (string) - The status of the order.

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "ord_987zyx",
      "productId": "prod_123abc",
      "orderDate": "2024-01-15T10:30:00Z",
      "status": "completed"
    },
    {
      "orderId": "ord_654wvu",
      "productId": "prod_456def",
      "orderDate": "2024-01-20T14:00:00Z",
      "status": "completed"
    }
  ]
}
```
```
Tokens:
Raw