Check plan coverage for a destination
check-coverageAnswer "does this eSIM plan work in X?" for one destination, as a yes or no rather than a country list. Takes a plan id and a destination (a country name or two-letter code). Reports whether the destination is covered, and separately whether it is explicitly excluded from an otherwise regional plan. Use get-plan-coverage when you need the full list of countries instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | The plan id (a ULID) as returned by list-plans. | |
| destination | Yes | The country to check: a name ("Japan") or a two-letter code ("JP"). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | The answer in a sentence, including what to do next when it is a no. | |
| covered | Yes | Whether this plan works at that destination. | |
| plan_id | Yes | The plan that was checked. | |
| excluded | Yes | Whether the destination is explicitly carved OUT of an otherwise regional plan. A different fact from simply not being included, and the only one of the two that means "do not buy this for that trip". Never true at the same time as covered. | |
| plan_name | Yes | Its name, e.g. "Europe 10GB". | |
| destination | Yes | ||
| is_worldwide | Yes | Whether the plan is sold as worldwide. | |
| region_label | Yes | Readable scope of a regional plan, e.g. "Europe". Null for a country plan. | |
| coverage_type | Yes | "country", "region" or "global". | |
| total_countries | Yes | How many countries the plan covers in total. |