Skip to main content
GET
Get an eSIM order

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

orderId
string
required

Order ULID. A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Response

Successful response.

id
string
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

kind
enum<string>
required
Available options:
purchase,
topup
status
enum<string>
required

completed is the success state. A failure refunds itself.

Available options:
provisioning,
completed,
failed,
refunded,
partially_refunded
package
object
required
quantity
integer
required
Required range: x >= 1
customerId
string | null
required

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

price
object
required

The USD list price.

paid
object
required

What was debited, in the paying account’s own currency.

fee
object
required
refunded
object
required
rate
string | null
required
externalReference
string
required
failureReason
string | null
required
profileIds
string[]
required

The eSIMs this order allocated.

A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
completedAt
string<date-time> | null
required
Example:

"2026-08-14T09:00:00.000Z"

createdAt
string<date-time>
required
Example:

"2026-08-14T09:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-08-14T09:00:00.000Z"