List products
Every product you can order, with what it covers and your wholesale price: the price you are invoiced for it. Fetch it once a day and cache it, rather than per order. Limited to 10 requests per minute per access key.
The filters narrow the list; an unknown value returns an empty list, not the whole catalogue.
option_id values here are what Create an
order takes.
It lists what is on sale. A destination we are preparing, or have paused, is
left out until it is on sale.
Fetch it once a day and cache it, rather than per order or per page view.
It returns the whole catalogue, about 11,000 rows, gzipped when your client
accepts it.
Filters
All optional. Without them you get the whole catalogue.country: an ISO code such asJP. Returns Japan’s own plans and every regional plan that covers Japan.location_type:countryorregion.location: a name exactly as the response spells it, such asJapan. Case does not matter.
Reading a row
datais the daily allowance as a person reads it. Unlimited plans readUnlimited; theirdata_mbis the full-speed part each day.countrieslists where the plan works: the country itself, or each country a region covers, with its ISO code.wholesale_price_usdis a string with two decimals, so it never arrives as a float.
Keeping your catalogue in sync
If you keep your own copy of the catalogue, for example to show plans or prices in your storefront, sync it once a day:- Fetch the whole list without filters, with
Accept-Encoding: gzip. - Key every row on
option_id. It is stable for a product and is what you order with. - Upsert. Add the
option_idvalues you have not seen, and update the ones you have.wholesale_price_usdis what you will be invoiced from then on, so compare it with what you stored and act on changes, such as repricing your own plan or flagging it for review. - Stop selling what is gone. An
option_idthat is no longer in the list is no longer on sale. Stop offering it to your customers.
Rate limit
10 requests per minute per access key. Going over returns429 Too Many Requests with a Retry-After header in seconds.Authorizations
Lowercase hex HMAC-SHA256 over the five-line string {METHOD}\n{REQUEST_PATH}\n{TIMESTAMP}\n{ACCESS_KEY}\n{BODY_SHA256}, keyed with your Base64-decoded secret key.
REQUEST_PATH includes the /api prefix and excludes the domain and any query string. BODY_SHA256 is the lowercase hex SHA-256 of the exact body bytes you send; for a request with no body, hash the empty string. The string always has five lines.