api/v1/orders/tarrifchange

Method: POST https://simportal-api.azurewebsites.net/api/v1/orders/tarrifchange?simId={simId}

Summary

Create a Tariff Change order which moves the tariff for a given SIM to a new tariff

Request Information

URI Parameters

NameDescriptionTypeAdditional information
simId

The unique SIM id that's been requested to apply to have its Tariff changed

 globally unique identifier

Required

Body Parameters

This model contains all of the information required to create a Tariff Change order

CreateTariffChangeOrderModel
NameDescriptionTypeAdditional information
TariffId

globally unique identifier

None.
Reason

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "TariffId": "c8648f12-257a-4f2c-bc22-49c5d7c88f07",
  "Reason": "sample string 2"
}

application/xml, text/xml

Sample: 
<CreateTariffChangeOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <Reason>sample string 2</Reason>
  <TariffId>c8648f12-257a-4f2c-bc22-49c5d7c88f07</TariffId>
</CreateTariffChangeOrderModel>

application/x-www-form-urlencoded

Sample: 
TariffId=a1234567-gu1d-3x4m-pl31-e1f2g12345678&Reason=samplestring

Response Information

Resource Description

OrderResponseModel
NameDescriptionTypeAdditional information
OrderId

globally unique identifier

None.
Created

date

None.
State

OrderState

None.
OrderTimescale

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "OrderId": "b1b577da-6543-4638-8a3b-0d3093e3773f",
  "Created": "2026-06-18T09:40:31.7216228+00:00",
  "State": 0,
  "OrderTimescale": "sample string 3"
}

application/xml, text/xml

Sample: 
<OrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <OrderTimescale>sample string 3</OrderTimescale>
</OrderResponseModel>