API v2.0 / Callback / eSIM Usage Callback
POST https://your-usage-callback-url/
POST
https://your-usage-callback-url/
When data is used on an eSIM, a usage event can be sent to a URL defined by you in the eSIM Portal. The usage event will report the current bundle in use by an eSIM, and it’s remaining data. Bundle names are case sensitive and should be typed like the following “esim_1GB_7D_IM_U”.
Example data:
{
"iccid": "8944538532008160222",
"alertType": "usage",
"bundle": {
"name": "A_BUNDLE_1GB",
"callTypeGroup": "callTypeGroup",
"initialQuantity": 1000.00,
"remainingQuantity": 90.00,
"startTime": "2006-01-02T15:04:05Z",
"endTime": "2007-01-02T15:04:05Z"
}
}
Request Body Notes:
- The “try” button for this endpoint is NOT functional
- The schema defines an example message that is sent to the configured callback URL.
- For more information on callback notification types, Please see the Notifications Page.
Request Body required
object
iccid
Your eSIM ICCID value
string
alertType
Type of callback alert
string
bundle
object
name
Name of Bundle applied to eSIM
string
callTypeGroup
string
initialQuantity
Starting quantity of data supplied by Bundle
integer format: float
remainingQuantity
Remaining quantity of data
integer format: float
startTime
Start time of Bundle.
Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’).
Example: 2006-01-02T15:04:05Z
string format: date-time
endTime
End time of Bundle.
Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’).
Example: 2007-01-02T15:04:05Z
string format: date-time