Plan [APIs]
Plan
Plans bundle Tariffs, Service Profiles, and commercial rules into an offer that can be assigned to endpoints.
POST Plan – Create
Endpoint
POST /api/createPlanHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Request body
Top-level object: planInfo
Field | Mandatory | Description |
|---|---|---|
planName | Yes | Plan name |
tariffId | Yes | Tariff id |
serviceProfileId | Yes | Service profile id |
status | Yes |
|
Result codes (selected)
Code | Description |
|---|---|
1601 | Create plan success |
1602 | Create plan failure |
1603 | Duplicate plan name |
10239 | Operation failed (verify completion) |
10240 | Operation timeout (verify completion) |
GET Plan (Query Rate Plan)
Endpoint
GET /api/QueryRatePlanHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Query parameters
Parameter | Mandatory | Description |
|---|---|---|
planId | No | Fetch a specific plan |
Response (selected)
Returned under responseParam.rows[]:
Field | Description |
|---|---|
planId | Plan id |
planName | Plan name |
tariffId | Linked tariff |
serviceProfileId | Linked service profile |
status | Plan status |
Result codes (selected)
Code | Description |
|---|---|
1604 | Get plan success |
1605 | Get plan failure |
1359 | No data available |
POST Plan – Modify
Endpoint
POST /api/modifyPlanHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Request body
Top-level object: planInfo
Field | Mandatory | Description |
|---|---|---|
planId | Yes | Plan id |
planName | No | Updated name |
tariffId | No | Updated tariff |
serviceProfileId | No | Updated service profile |
status | No | Updated status |
Result codes (selected)
Code | Description |
|---|---|
1606 | Modify plan success |
1607 | Modify plan failure |
10239 | Operation failed (verify completion) |
10240 | Operation timeout (verify completion) |
POST Plan – Delete
Endpoint
POST /api/deletePlanHeaders
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>Request body
Top-level object: planInfo
Field | Mandatory | Description |
|---|---|---|
planId | Yes | Plan id |
Result codes (selected)
Code | Description | Next steps |
|---|---|---|
1608 | Delete plan success | — |
1609 | Delete plan failure | — |
1610 | Plan attached to endpoint | Detach endpoint before deletion |
Cross-API parameter sourcing
tariffId: via GET TariffserviceProfileId: via GET Service ProfileplanId: via GET Query Rate Plan or Create responseDependency checks:
Endpoint usage: via endpoint assignment APIs