Order a top-up
POST/v1/esims/:esim_id/top_ups
Adds data to a package already running on this eSIM.
Nothing is installed and nothing is replaced: the traveller keeps the profile they have, and the data lands against the package the add-on belongs to. There is no new activation code because there is no new profile.
top_up_id must be one currently listed for this eSIM. An add-on
that has stopped being sold, or one belonging to a package that is
not running, is refused with esim_top_up_unavailable — read the
list immediately beforehand rather than trusting a cached one.
One top-up, bought once. A top-up lands on the allowance the package is running today — it cannot be bought ahead for a later day, and it expires with the package it extends, so one bought late in that package's life buys less time than the same one bought early.
Send an Idempotency-Key. A timed-out top-up retried without one
is a second purchase.
Request
Responses
- 201
- 400
- 404
- 409
- 422
The top-up order.
The request is malformed or contains an unrecognized parameter.
The resource does not exist, or belongs to another organization. The two are deliberately indistinguishable.
Idempotency key reused with a different body, or a concurrent modification.
Well-formed but fails a business rule.