Skip to main content
GET
Get a plan

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Path Parameters

slug
string
required

Plan slug.

Response

Successful response.

slug
string
required

Stable identifier for the plan. Send it when quoting or buying.

name
string
required
description
string | null
required
region
object | null
required
dataType
enum<string>
required
Available options:
fixed,
unlimited,
daily
data
object
required
validityDays
integer
required
Required range: x >= 1
price
object
required
supportsTopUp
boolean
required

Whether this plan can extend an eSIM already installed.

supportsPlatformSms
boolean
required

Whether the provider flags this plan as SMS-capable. Not a phone number and not inbound SMS: an eSIM has no MSISDN and cannot receive a message. It concerns only messages the platform pushes to the handset.

coverage
string[]
required

ISO 3166-1 alpha-2 codes the plan covers.