Start a top-up
topup_startInitiate a top-up or recharge for an existing phone line or eSIM using a product ID from topup_lookup. Returns an order ID and payment URL, and accepts custom amounts for range plans.
Instructions
Start a top-up/recharge for an existing line or eSIM, using a product_id from topup_lookup. Returns an order_id and a payment URL where the customer completes payment. For range plans, pass custom_amount.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"line_type": "<line_type>",
"product_id": "<product_id>",
"customer_email": "<customer_email>"
},
"name": "topup_start"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iccid | No | eSIM ICCID (esim). | |
| phone | No | US phone (us_prepaid). | |
| carrier | No | ||
| line_type | Yes | ||
| product_id | Yes | Top-up plan id from topup_lookup. | |
| custom_amount | No | For range/RTR plans only. | |
| customer_email | Yes | ||
| source_order_id | No | Original eSIM order id (esim). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| amount | Yes | ||
| status | Yes | ||
| message | No | ||
| product | No | ||
| currency | Yes | ||
| order_id | Yes | ||
| payment_url | No |