Skip to content
/
Port-in for an active sub...

Elevate Provisioning API (2.1)

Provisioning

Provides API access to activate, reactivate, suspend and deactivate mobile SIMs

Download OpenAPI description
billing-rest-provisioning.json
billing-rest-provisioning.yaml
Languages
Servers
https://rest.elevatebilling.com/v2

provisioning

Provisioning requests to activate, reactivate, suspend and deactivate mobile SIMs

Operations

Activate a new mobile SIM

Request

Security
bearerAuth
Bodyapplication/jsonrequired

Request to activate mobile SIM

rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
portingRequestobject(PortingRequest)
curl -i -X POST \
  https://rest.elevatebilling.com/v2/sim-activation-request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalProductInventoryId": 1,
    "portingRequest": {
      "portingPacCode": "ABC123456",
      "requestedPortingDate": "2023-10-12"
    }
  }'

Responses

OK

Bodyapplication/json
rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
provisioningStatusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
failureReasonstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Failure Reason

transactionIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Provisioning transaction id

Response
application/json
{
  "rentalProductInventoryId": 1,
  "provisioningStatus": "INACTIVE",
  "failureReason": "string",
  "transactionId": "string"
}

Suspend a mobile SIM

Request

Security
bearerAuth
Bodyapplication/jsonrequired

Request to suspend mobile SIM

rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
curl -i -X POST \
  https://rest.elevatebilling.com/v2/sim-suspension-request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalProductInventoryId": 1
  }'

Responses

OK

Bodyapplication/json
rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
provisioningStatusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
failureReasonstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Failure Reason

transactionIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Provisioning transaction id

Response
application/json
{
  "rentalProductInventoryId": 1,
  "provisioningStatus": "INACTIVE",
  "failureReason": "string",
  "transactionId": "string"
}

Reactivate a mobile SIM

Request

Security
bearerAuth
Bodyapplication/jsonrequired

Request to reactivate mobile SIM

rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
curl -i -X POST \
  https://rest.elevatebilling.com/v2/sim-reactivation-request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalProductInventoryId": 1
  }'

Responses

OK

Bodyapplication/json
rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
provisioningStatusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
failureReasonstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Failure Reason

transactionIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Provisioning transaction id

Response
application/json
{
  "rentalProductInventoryId": 1,
  "provisioningStatus": "INACTIVE",
  "failureReason": "string",
  "transactionId": "string"
}

Modify options on this product

Request

Security
bearerAuth
Bodyapplication/jsonrequired

Request to modify a product with option(s)

rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
optionsobject(Option)required
options.​property name*stringadditional property

A list of requested modify options in key/value format, i.e. "{ "NAME":"VALUE" }"

Example: "TSL_INTERNATIONAL_BARRING"
curl -i -X POST \
  https://rest.elevatebilling.com/v2/sim-modification-request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalProductInventoryId": 1,
    "options": {
      "TSL_SMART_BAR": "On"
    }
  }'

Responses

OK

Bodyapplication/json
rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
provisioningStatusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
failureReasonstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Failure Reason

transactionIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Provisioning transaction id

Response
application/json
{
  "rentalProductInventoryId": 1,
  "provisioningStatus": "INACTIVE",
  "failureReason": "string",
  "transactionId": "string"
}

Subscribe a feature or event

Request

Subscribe a feature or event to a data bundle or add-on respectively

Security
bearerAuth
Bodyapplication/jsonrequired

Request to subscribe a FEATURE or EVENT rental product inventory

rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
curl -i -X POST \
  https://rest.elevatebilling.com/v2/sim-subscription-request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalProductInventoryId": 1
  }'

Responses

OK

Bodyapplication/json
rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
provisioningStatusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
failureReasonstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Failure Reason

transactionIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Provisioning transaction id

Response
application/json
{
  "rentalProductInventoryId": 1,
  "provisioningStatus": "INACTIVE",
  "failureReason": "string",
  "transactionId": "string"
}

Port-in for an active subscription

Request

Port-in of a provided MSISDN on a given porting date for an already active subscription

Security
bearerAuth
Bodyapplication/jsonrequired

Request to port in a number

rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
portingRequestobject(PortingRequest)
curl -i -X POST \
  https://rest.elevatebilling.com/v2/port-in-number-request \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rentalProductInventoryId": 1,
    "portingRequest": {
      "portingPacCode": "ABC123456",
      "requestedPortingDate": "2023-10-12",
      "portingNumber": "07123456789"
    }
  }'

Responses

OK

Bodyapplication/json
rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
provisioningStatusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
failureReasonstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Failure Reason

transactionIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Provisioning transaction id

Response
application/json
{
  "rentalProductInventoryId": 1,
  "provisioningStatus": "SUCCESS",
  "transactionId": "5e6e9753-977a-4f0a-97fe-10371007e2d2"
}