Cloud Services

ModernOps configuration

APIs for RateCard/UI
Published On Jul 08, 2024 - 9:44 AM

APIs for RateCard/UI

Learn what the RateCard/UI APIs are and what they are used for.
The following are the RateCard/UI APIs, including parameters, and what they are used for.
API:
GET/shared/ratecard/ui/{rc_id}
Used for:
Getting the RateCard UI
Parameters
Name
Description
rc_id *
required
string
(path)
rc_id
Response content type: application/json
Responses
Code
Description
200
OK
Example Value |
Model
{
  "currency_code": "USD",
  "groups": [
    {
      "description": "rate card group description",
      "id": "646b4fb9-9edc-494c-89af-abe43b3a3a52",
      "items": [
        {
          "description": "rate card item test",
          "frequency": {
            "code": "YEAR",
            "value": 2013
          },
          "id": "e33da133-dfac-4b70-bd89-cb81ba1d5eac",
          "name": "item001",
          "parameters": "string"
        }
      ],
      "name": "group_name"
    }
  ],
  "id": "5ed3cde0-079f-4867-aea5-400c4372ca67",
  "plan_id": "9ae911a4-faf5-4120-b80c-8682f77ebfe6"
}
404
Not Found
422
Unprocessable Entity
API:
GET/shared/ratecard/ui/{rc_id}/plan/{plan_id}/group/{group_id}/item/{item_id}
Used for:
Getting the RateCard UI Item
Parameters
Name
Description
rc_id *
required
string
(path)
rc_id
plan_id *
required
string
(path)
plan_id
group_id *
required
string
(path)
group_id
item_id *
required
string
(path)
item_id
Response content type: application/json
Responses
Code
Description
200
OK
Example Value |
Model
{
  "description": "rate card item test",
  "frequency": {
    "code": "YEAR",
    "value": 2013
  },
  "id": "e33da133-dfac-4b70-bd89-cb81ba1d5eac",
  "name": "item001",
  "parameters": "string"
}
404
Not Found
API:
GET/shared/ratecard/ui/{rc_id}/plan/{plan_id}/group/{group_id}/variables
Used for:
Getting the RateCard UI Variables
Parameters
Name
Description
rc_id *
required
string
(path)
rc_id
plan_id *
required
string
(path)
plan_id
group_id *
required
string
(path)
group_id
Response content type: application/json
Responses
Code
Description
200
OK
Example Value |
Model
{
  "data_type": "number",
  "description": "rate card variable test",
  "id": "variable",
  "name": "variablename",
  "value": "string"
}
404
Not Found
Do you have two minutes for a quick survey?
Take Survey