Get top-up package list

Overview
Use this endpoint to retrieve the top-up packages that can be purchased for a specific eSIM. When you call the endpoint with an eSIM’s ICCID, the response returns the eligible top-up packages for that eSIM (based on the ICCID provided). The endpoint supports new type of packages: “Voice and Text”.
This endpoint is designed for the top-up flow: it helps you present only the top-ups that are actually available for the eSIM’s operator/configuration, along with the package details you need to display and sell them (e.g., package ID, price, data amount, and duration).⁠

Note for unlimited packages

For unlimited packages the remaining, total and amount fields will default to 0 should be ignored, and not displayed to the end users.

When in Sandbox mode, the is_unlimited field can be false for an unlimited package ordered, due to not having real eSIMs available, thus don't reflect real usage.

How to use this endpoint

Make a request to this endpoint and provide the iccid of the eSIM for which you want to retrieve top-up packages for.

The API will respond with a JSON object containing an array of purchased top-up packages for the eSIM, each of which includes an ID, remaining data amount, activation and expiration dates, and other relevant information.

For more information and best practices visit our FAQ page.

application/json

Bodyapplication/json

Examples

eSIM: List available top-up packages: 200 OKeSIM: List available top-up packages: 200 (No top-up packages available)eSIM: List available top-up packages: 404 (Invalid ICCID)Recycled Sim ResponseSuccess

{
    "pricing": {
        "model": "net_pricing",
        "discount_percentage": 0
    },
    "data": [
        {
            "id": "bonbon-mobile-30days-3gb-topup",
            "type": "topup",
            "price": 10,
            "amount": 3072,
            "day": 30,
            "is_unlimited": false,
            "title": "3 GB - 100 SMS - 100 Mins - 30 Days",
            "data": "3 GB",
            "short_info": "This eSIM doesn't come with a phone number.",
            "voice": 100,
            "text": 100,
            "net_price": 8
        },
        {
            "id": "bonbon-mobile-30days-5gb-topup",
            "type": "topup",
            "price": 14,
            "amount": 5120,
            "day": 30,
            "is_unlimited": false,
            "title": "5 GB - 30 Days",
            "data": "5 GB",
            "short_info": "This eSIM doesn't come with a phone number.",
            "voice": 100,
            "text": 100,
            "net_price": 11.2
        },
        {
            "id": "bonbon-mobile-30days-10gb-topup",
            "type": "topup",
            "price": 23,
            "amount": 10240,
            "day": 30,
            "is_unlimited": false,
            "title": "10 GB - 30 Days",
            "data": "10 GB",
            "short_info": "This eSIM doesn't come with a phone number.",
            "voice": 100,
            "text": 100,
            "net_price": 18.4
        }
    ]
}

Request

Request Code Samples

Responses