Get eSIM plan details
get-planRead everything about one eSIM plan by its id: data allowance, how long it stays valid, what happens after a fair-use cap, whether hotspot and top-ups are supported, the network it runs on, and the retail price in the currency you ask for. Use it to answer a specific question about a plan already found with list-plans or plan-trip, and before buying, to confirm the plan really matches what the traveller asked for. Ask get-plan-coverage instead when the question is which countries it works in. Read-only: it reserves nothing and charges nothing.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"plan_id": "<plan_id>"
},
"name": "get-plan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | The plan id: a 26-character ULID as returned by list-plans or plan-trip, e.g. "01JVQ2S6D4X8N0RMB7YQZ5K3TA". Slugs and supplier codes are not accepted, and an id must never be invented. | |
| currency | No | Optional. ISO 4217 three-letter code the price is quoted in, e.g. "USD", "EUR", "GBP". Defaults to EUR. An unknown code falls back to EUR rather than failing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The plan id (a 26-character ULID). Pass it to get-plan, get-plan-coverage or create-checkout-session. Never invent one. | |
| name | Yes | Plan name as a traveller sees it, e.g. "Spain 5GB". | |
| type | Yes | What the plan sells: data only, or data plus a bundled voice and SMS allowance. | |
| links | Yes | Where a person buys this plan on simfuse.app. | |
| region | Yes | Raw region value for a regional plan, e.g. "Europe". Null for a country plan. | |
| carrier | Yes | The mobile network this plan runs on, when we can name it. Null when we cannot. | |
| country | Yes | The one country this plan is filed under. Null for a regional or worldwide plan. | |
| network | Yes | The network name as plain text, or null when unknown. | |
| currency | Yes | ISO 4217 code retail_price_cents is quoted in, e.g. "EUR". | |
| operators | Yes | Network operators the plan roams on, as a list. Empty when none are published. | |
| is_worldwide | Yes | True when the plan is sold as a worldwide bundle. | |
| network_type | Yes | Deprecated two-valued form: "5G" for a 5G plan, "LTE" for everything else including plans whose generation was never stated. Read network_generation. | |
| region_label | Yes | The region formatted for a person to read. Null for a country plan. | |
| coverage_type | Yes | Scope of the plan: one country, a region, or worldwide. | |
| validity_days | Yes | How many days the plan stays valid once it activates. | |
| coverage_count | Yes | How many countries coverage_countries holds. | |
| data_amount_mb | Yes | Data allowance in megabytes (1 GB is 1024 MB). 0 on an unlimited plan, where data_usage_policy carries the real terms. | |
| excluded_count | Yes | How many countries excluded_countries holds. | |
| supports_topup | Yes | Whether more data can be bought for the same eSIM once it runs low. | |
| data_usage_policy | Yes | What the plan really gives you. Null when the supplier has never published its terms, which is different from having no limits. | |
| coverage_countries | Yes | Every country the plan works in. | |
| excluded_countries | Yes | Countries in this plan's own region that it does NOT cover. Always empty for a country plan and for a worldwide one. | |
| network_generation | Yes | The network generation the plan is sold as, exactly as stated for it. Null means not stated, which is not the same as any generation; say "not stated" rather than assuming. | |
| retail_price_cents | Yes | Retail price in minor units (cents) of `currency`, so 1250 in EUR is 12.50 EUR. This is what a buyer pays for one eSIM. | |
| supports_tethering | Yes | Whether hotspot or tethering is allowed. Null means no supplier has declared it, which is not the same as "no". | |
| retail_prices_cents | No | Prices in other currencies, keyed by ISO 4217 code, in minor units. Only the multi-currency surfaces (the catalog export) carry one, so it is absent here: read retail_price_cents and currency instead. | |
| hotspot_usage_policy | Yes | What the plan lets you do with a hotspot. Null when the terms were never established, which is different from being allowed. | |
| data_restriction_type | Yes | Whether the allowance is capped ("limited") or unmetered ("unlimited"). |