Quibity AI connector documentation

Lists the customer's eSIMs, newest first, with id, ICCID, name, destination, status, days left, expiry and data left. Unlimited plans show data as unlimited (never quote a data total or usage for them). ready is false while the carrier is still preparing an eSIM. Expired eSIMs and eSIMs the customer archived in the Quibity app are included only on request (archiving is done in the app, not here). Use get_esim for one eSIM in detail and get_esim_installation for its QR code.

Details of one of the customer's eSIMs by esim_id or ICCID: status, destination, plan, days left, expiry, data used and left, and the installation details (QR code URL, activation code, iPhone link) while the eSIM can still be installed. Unlimited plans show only days and the fair use line, never a data total or usage. A pending eSIM (ready false) is still being prepared by the carrier: the customer gets an email when it is ready.

How to install one of the customer's eSIMs, by esim_id or ICCID: the QR code image URL, the SM-DP+ address and activation code for manual entry, the full LPA string, an iPhone install link and short steps. Available only while the eSIM is not installed yet (or was deleted from the phone). A pending eSIM has no installation details yet: the customer gets an email when it is ready.

Lists the countries and regions Quibity sells eSIM plans for, with the destination_id that get_plans takes and the name in the customer's language. A region plan covers several countries.

Plans and prices for a destination (country or region destination_id from list_destinations), in the customer's currency unless another supported currency is given. Fixed plans list their data in GB and days. Unlimited plans have no data limit and carry a fair use line (high speed GB per day, then the speed after it). VAT, where it applies, is added at checkout. Use the plan_id to buy a plan.

The connected Quibity account: email, name, language, account balance with its currency, and the number of eSIMs (the same ones list_esims shows by default). The balance can pay for plans and top ups.

Gives one of the customer's eSIMs (by esim_id or ICCID) a custom name, for example the trip it is for. The name is shown in the Quibity app and on the website instead of the plan name. Between 1 and 40 characters. Returns the updated eSIM.

Buys an eSIM plan (plan_id from get_plans). quantity is the number of eSIMs (default 1), coupon an optional discount code. Two ways to pay. By default (use_balance false) it charges nothing and returns a checkout link with the price summary: the customer opens it in a browser, lands logged in to their Quibity account and pays there. The link works once and expires in 15 minutes; VAT, where it applies, is added at checkout. With use_balance true the purchase is paid from the account balance in two steps. The first call charges nothing and returns a quote (total with VAT, balance, balance after) with a confirmation_token: show the quote to the customer. Only after the customer confirms, call again with the same arguments plus the confirmation_token: that call charges the balance and returns the new eSIMs with their installation details (an eSIM with ready false is still being prepared by the carrier). If the balance does not cover the price, nothing is charged and a checkout link comes back that applies the balance, with to_pay_by_card for the rest. Never send a confirmation_token the customer has not explicitly confirmed.

Buys a top up (more data and days) of one of the customer's eSIMs, by esim_id or ICCID. refill_id must be one of the top ups of that eSIM: a call with an unknown refill_id answers with the available ones (refill_id, data, days, price). Two ways to pay. By default (use_balance false) it charges nothing and returns a checkout link with the price: the customer opens it in a browser, lands logged in to their Quibity account and pays there. The link works once and expires in 15 minutes. With use_balance true the top up is paid from the account balance in two steps. The first call charges nothing and returns a quote (total, balance, balance after) with a confirmation_token: show the quote to the customer. Only after the customer confirms, call again with the same arguments plus the confirmation_token: that call charges the balance and returns the refreshed eSIM. If the balance does not cover the price, nothing is charged and a checkout link comes back that applies the balance, with to_pay_by_card for the rest. Never send a confirmation_token the customer has not explicitly confirmed.

Returns a checkout link that adds money to the customer's Quibity account balance, which pays for eSIMs and top ups. The customer opens the checkout link in a browser, lands logged in and pays there; this tool charges nothing. amount must be one of the top up amounts of the currency (the account currency unless another supported one is given): a call with another amount answers with the allowed ones. The link works once and expires in 15 minutes.