Notifications / Notifications / First Use

Server

POST

FirstUse

One time notification that is sent the first time an eSIM successfully uses any data to the nearest 1kb. First use can be used to notify your end-users their bundle has now started and the bundle duration has started. This will replace the 1% notification which can be removed.

Request Body ^required

object

alertType

Type of alert

string

iccid

ICCID of the eSIM

string

8944538532008160222

bundle

object

name

Name of the bundle

string

A_BUNDLE_1GB

initialQuantity

Initial quantity of the bundle (Bytes)

integer

1000000000

remainingQuantity

Remaining quantity of the bundle (Bytes)

integer

1000000000

startTime

Start time of the bundle

string

2006-01-02T15:04:05Z

endTime

End time of the bundle

string

2007-01-02T15:04:05Z

Examples

{
  "alertType": "FirstUse",
  "iccid": 8944538532008160000,
  "bundle": {
    "name": "A_BUNDLE_1GB",
    "initialQuantity": 1000000000,
    "remainingQuantity": 1000000000,
    "startTime": "2006-01-02T15:04:05Z",
    "endTime": "2007-01-02T15:04:05Z"
  }
}

Responses

None

No response body