Namirasoft Cost API V1

Namira Software Corporation Cost API Version 1 (1.4.10)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-cost-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-cost healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-cost value list {table} {column} {search} {field_id} {limit}

Copied!

BillWatchAWS

Estimation

Returns the BillWatch cost estimation for an AWS Watch

ns-cost billwatchaws estimation

Copied!

--first_watch_created_at (DateTime)

--period (Object)

--active (Boolean)

_CreateFor

Creates a new cost for a user_id for bill-watch aws

ns-cost billwatchaws _createfor {user_id}

Copied!

--first_watch_created_at (DateTime)

--period (Object)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

BillWatchAzure

Estimation

Returns the BillWatch cost estimation for an Azure Watch

ns-cost billwatchazure estimation

Copied!

--first_watch_created_at (DateTime)

--period (Object)

--active (Boolean)

_CreateFor

Creates a new cost for a user_id for bill-watch azure

ns-cost billwatchazure _createfor {user_id}

Copied!

--first_watch_created_at (DateTime)

--period (Object)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

BillWatchGCP

Estimation

Returns the BillWatch cost estimation for an GCP Watch

ns-cost billwatchgcp estimation

Copied!

--first_watch_created_at (DateTime)

--period (Object)

--active (Boolean)

_CreateFor

Creates a new cost for a user_id for bill-watch gcp

ns-cost billwatchgcp _createfor {user_id}

Copied!

--first_watch_created_at (DateTime)

--period (Object)

--active (Boolean)

--workspace_id (String)

--resource_id (String)

Cost

List

Returns the cost list

ns-cost cost list {filters} {page} {size} {sorts}

Copied!

_CreateFor

Creates a new cost for a user_id

ns-cost cost _createfor {user_id}

Copied!

--workspace_id (String)

--product_id (String)

--sales_item_id (String)

--offer_id (String)

--offer_item_id (String)

--resource_entity (String)

--resource_id (String)

--usage_name (String)

--usage_value (Double)

--usage_unit (String)

--period_start (DateTime)

--period_end (DateTime)

--amount (Double)

--currency (String)

Schemas


Period

{
  "name": "Period",
  "type": "Object",
  "required": true
}

Estimation

{
  "name": "Estimation",
  "type": "Object",
  "required": true
}

Cost

{
  "name": "Cost",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true
    },
    "workspace_id": {
      "type": "String",
      "required": true
    },
    "product_id": {
      "type": "String",
      "required": true
    },
    "sales_item_id": {
      "type": "String",
      "required": true
    },
    "offer_id": {
      "type": "String",
      "required": true
    },
    "offer_item_id": {
      "type": "String",
      "required": true
    },
    "resource_entity": {
      "type": "String",
      "required": true
    },
    "resource_id": {
      "type": "String",
      "required": true
    },
    "usage_name": {
      "type": "String",
      "required": true
    },
    "usage_value": {
      "type": "Double",
      "required": true
    },
    "usage_unit": {
      "type": "String",
      "required": true
    },
    "period_start": {
      "type": "DateTime",
      "required": true
    },
    "period_end": {
      "type": "DateTime",
      "required": true
    },
    "amount": {
      "type": "Double",
      "required": true
    },
    "currency": {
      "type": "String",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

CostCreate

{
  "name": "CostCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": true
    },
    "product_id": {
      "type": "String",
      "required": true
    },
    "sales_item_id": {
      "type": "String",
      "required": true
    },
    "offer_id": {
      "type": "String",
      "required": true
    },
    "offer_item_id": {
      "type": "String",
      "required": true
    },
    "resource_entity": {
      "type": "String",
      "required": true
    },
    "resource_id": {
      "type": "String",
      "required": true
    },
    "usage_name": {
      "type": "String",
      "required": true
    },
    "usage_value": {
      "type": "Double",
      "required": true
    },
    "usage_unit": {
      "type": "String",
      "required": true
    },
    "period_start": {
      "type": "DateTime",
      "required": true
    },
    "period_end": {
      "type": "DateTime",
      "required": true
    },
    "amount": {
      "type": "Double",
      "required": true
    },
    "currency": {
      "type": "String",
      "required": true
    }
  }
}

Enums

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.