Submit top-up order

To submit a top-up order:

Make a POST request to the endpoint URL {{url}}/{{version}}/orders/topups

Include a request body in the form of a FormData object, which contains the following required fields:

package_id: The ID of the top-up package you want to purchase

iccid: The ICCID of the eSIM for which you want to purchase the top-up package.

You can also include an optional description field to provide additional information about the order.

The API will respond with a JSON object containing the details of the order, including the package ID, quantity, price, and other information.

The complete workflow for buying a top-up package:

GET {{url}}/{{version}}/sims to see the list of purchased eSIMs

GET {{url}}/{{version}}/sims/:iccid/topups to see the list of available top-ups for the eSIMs

POST {{url}}/{{version}}/orders/topups with the proper "iccid" and "package_id" values to purchase a top-up

GET {{url}}/{{version}}/sims/:iccid/packages to see the list of all packages for the eSIM, including the original package and top-ups

curl --location --request POST 'https://prod.your-api-server.com/customer/v2/orders/topups' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}' \ --form 'package_id="bonbon-mobile-30days-3gb-topup"' \ --form 'iccid="89340000000000872"' \ --form 'description="Example description to identify the order"'

{ "data": { "id": 12345, "created_at": "2024-01-15T10:30:00Z", "code": "ORD-12345", "package_id": "bonbon-mobile-30days-3gb-topup", "quantity": "1", "type": "sim", "description": "Top-up for customer John Doe", "esim_type": "data", "validity": 30, "package": "3 GB - 100 SMS - 100 Mins - 30 Days", "data": "3 GB", "price": 10.00, "currency": "USD" }, "meta": { "message": "success" } }

Request

Responses