Get Top-up Package List

GET

/v1/sims/{iccid}/topups

To get the list of available packages for an eSIM:

Make a GET request to the endpoint URL {{url}}/{{version}}/sims/:iccid/topups, replace :iccid with the ICCID of the eSIM for which you want to purchase a top-up.

The API will respond with a JSON object containing an array of available top-up packages, each of which includes an ID, price, data amount, duration, and other information.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1/sims/8910300000005271146/topups' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Response Example

200 - eSIM: List available top-up packages: 200 OK - eSIM: List available top-up packages: 200 OK

{
  "data": [
    {
      "id": "bonbon-mobile-30days-3gb-topup",
      "type": "topup",
      "price": 10,
      "amount": 3072,
      "day": 30,
      "is_unlimited": false,
      "title": "3 GB - 30 Days",
      "data": "3 GB",
      "short_info": null
    },
    {
      "id": "bonbon-mobile-30days-5gb-topup",
      "type": "topup",
      "price": 15,
      "amount": 5120,
      "day": 30,
      "is_unlimited": false,
      "title": "5 GB - 30 Days",
      "data": "5 GB",
      "short_info": null
    },
    {
      "id": "bonbon-mobile-30days-10gb-topup",
      "type": "topup",
      "price": 22.5,
      "amount": 10240,
      "day": 30,
      "is_unlimited": false,
      "title": "10 GB - 30 Days",
      "data": "10 GB",
      "short_info": null
    }
  ]
}

Request

Path Params

iccid

string

required

eSIM ICCID, used to query a list of available top-up packages.
Required. Can be obtained by execuring GET to the "eSIMs List" endpoint

Example:

8910300000005271146

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Responses

🟢200eSIM: List available top-up packages: 200 OK

application/json

Body

data

array [object {9}]

required

string

required

type

string

required

price

integer | number

required

amount

integer

required

day

integer

required

is_unlimited

boolean

required

title

string

required

data

string

required

short_info

null

required

🟢200eSIM: List available top-up packages: 200 (No top-up packages available)

🟢200eSIM: List available top-up packages: 404 (Invalid ICCID)

Modified at 2024-11-22 09:33:20

Get Data Usage

Get eSIM Package History