Skip to main content
POST
Quote a top-up

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

profileId
string
required

eSIM ULID. A 26-character ULID.

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

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Body

application/json

The plan must cover the same destination as the eSIM being topped up.

debitAccountId
string
required

A 26-character ULID.

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

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

packageSlug
string
Maximum string length: 200
packageId
string

A 26-character ULID.

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

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Response

Successful response.

package
object
required
quantity
integer
required
Required range: x >= 1
price
object
required
fee
object
required
payable
object
required
rate
string | null
required

Units of the paying currency per USD. Null when the account is already USD.

fxQuoteId
string | null
required

Send this when buying. Null when no conversion is needed.

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

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

expiresAt
string<date-time> | null
required
Example:

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