HyperstackApi.BillingApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method	HTTP request	Description
bucketsBillingHistoryHourlyChart	GET /billing/billing/history/bucket/{bucket_id}/graph	Retrieve hourly cost datapoints of a Specific Bucket for a specific billing cycle
getBucketBillingHistory	GET /billing/billing/history/bucket/{bucket_id}	Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle
getClusterBillingHistory	GET /billing/billing/history/cluster/{cluster_id}	Retrieve Billing History of a Specific Cluster for a specific Billing Cycle
getClusterBillingHistoryGraph	GET /billing/billing/history/cluster/{cluster_id}/graph	Retrieve hourly cost datapoints of a specific Cluster for a specific billing cycle
getDataSynthesisBillingHistory	GET /billing/billing/history/data_synthesis	Retrieve Billing History of data synthesis for a specific Billing Cycle
getDataSynthesisBillingHistoryGraph	GET /billing/billing/history/data_synthesis/{resource_id}/graph	Retrieve hourly cost datapoints of a Specific Data Synthesis for a specific
getDataSynthesisHistoryForResource	GET /billing/billing/history/data_synthesis/{resource_id}
getFineTuningBillingHistory	GET /billing/billing/history/fine_tuning	Retrieve Billing History of model evaluation for a specific Billing Cycle
getFineTuningBillingHistoryGraph	GET /billing/billing/history/fine_tuning/{resource_id}/graph	Retrieve hourly cost datapoints of a Specific Fine Tuning for a specific billing cycle
getLastDayCost	GET /billing/billing/last-day-cost	GET: Last Day Cost
getModelEvaluationBillingHistory	GET /billing/billing/history/model_evaluation	Retrieve Billing History of model evaluation for a specific Billing Cycle
getModelEvaluationBillingHistoryGraph	GET /billing/billing/history/model_evaluation/{resource_id}/graph	Retrieve hourly cost datapoints of a Specific Model Evaluation for a specific
getNotificationThreshold	PUT /billing/billing/threshold/{threshold_id}	Update: Subscribe or Unsubscribe Notification Threshold
getResourceFineTuningBillingHistory	GET /billing/billing/history/fine_tuning/{resource_id}	Retrieve Billing History of a Specific Fine Tuning for a specific Billing Cycle
getResourceModelEvaluationBillingHistory	GET /billing/billing/history/model_evaluation/{resource_id}
getServerlessInferenceBillingHistoryGraph	GET /billing/billing/history/serverless_inference/{resource_id}/graph	Retrieve hourly cost datapoints of a Specific Serverless Inference for a specific
getServerlessInferencesBillingHistory	GET /billing/billing/history/serverless_inference/{resource_id}
getSnapshotBillingHistory	GET /billing/billing/history/snapshot/{snapshot_id}	Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle
getSnapshotBillingHistoryGraph	GET /billing/billing/history/snapshot/{snapshot_id}/graph	Retrieve hourly cost datapoints of a Specific Snapshot for a specific billing cycle
getUsage	GET /billing/billing/usage	GET: Billing usage
getUserBillingHistory	GET /billing/billing/history	Retrieve Billing History for a specific Billing Cycle
getVMBillingDetails	GET /billing/billing/history/virtual-machine/{vm_id}	Retrieve Billing History of a Specific Virtual Machine for a specific Billing Cycle
getVMBillingEvents	GET /billing/billing/virtual-machine/{vm_id}/billing-events	Retrieve VM billing events history
getVMBillingGraph	GET /billing/billing/history/virtual-machine/{vm_id}/graph	Retrieve hourly cost datapoints of a Specific Virtual Machine for a specific billing cycle
getVMBillingHistory	GET /billing/billing/history/virtual-machine	Retrieve Billing History of Virtual Machine for a specific Billing Cycle
getVMSubResourceCosts	GET /billing/billing/virtual-machine/{vm_id}/sub-resource	Retrieve Total Costs and Non Discount Costs for Sub Resources
getVMSubResourceGraph	GET /billing/billing/virtual-machine/{vm_id}/sub-resource/graph	Retrieve Sub-Resources Historical Cost datapoints of a Virtual
getVolumeBillingDetails	GET /billing/billing/history/volume/{volume_id}	Retrieve Billing History of a Specific Volume for a specific Billing Cycle
getVolumeBillingEvents	GET /billing/billing/volume/{volume_id}/billing-events	Retrieve Volume billing events history
getVolumeBillingHistory	GET /billing/billing/history/volume	Retrieve Billing History of Volume for a specific Billing Cycle
getVolumeBillingHistoryGraph	GET /billing/billing/history/volume/{volume_id}/graph	Retrieve hourly cost datapoints of a Specific Volume for a specific billing cycle
listBillingContractHistory	GET /billing/billing/history/contract	Retrieve Billing History of Contract for a specific Billing Cycle
listBucketBillingHistory	GET /billing/billing/history/bucket	Retrieve Billing History of a Bucket for a specific Billing Cycle
listClustersBillingHistory	GET /billing/billing/history/cluster	Retrieve Billing History of Clusters for a specific Billing Cycle
listOrgNotificationThresholds	GET /billing/billing/threshold	GET: All Thresholds for Organization
listServerlessInferenceBillingHistory	GET /billing/billing/history/serverless_inference	Retrieve Billing History of serverless inference for a specific Billing Cycle
listSnapshotBillingHistory	GET /billing/billing/history/snapshot	Retrieve Billing History of Snapshot for a specific Billing Cycle

bucketsBillingHistoryHourlyChart

ResourceLevelGraphBillingDetailsBucket bucketsBillingHistoryHourlyChart(bucketId, opts)

Retrieve hourly cost datapoints of a Specific Bucket for a specific billing cycle

User will receive hourly cost datapoints for a Bucket for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let bucketId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.bucketsBillingHistoryHourlyChart(bucketId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
bucketId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelGraphBillingDetailsBucket

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getBucketBillingHistory

ResourceLevelBucketBillingDetailsResponseModel getBucketBillingHistory(bucketId, opts)

Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle

Retrieve billing history of a specific Bucket for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let bucketId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Datetime should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Datetime should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getBucketBillingHistory(bucketId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
bucketId	Number
startDate	String	Datetime should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Datetime should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelBucketBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getClusterBillingHistory

ResourceLevelClusterBillingDetailsResponseModel getClusterBillingHistory(clusterId, opts)

Retrieve Billing History of a Specific Cluster for a specific Billing Cycle

User will receive billing history of a specific Cluster for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'non_discounted_price_per_hour', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'usage_time_ACTIVE', 'usage_time_SHUTOFF', 'usage_time_HIBERNATED'.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let clusterId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getClusterBillingHistory(clusterId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
clusterId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelClusterBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getClusterBillingHistoryGraph

ResourceLevelClusterGraphBillingDetailsResponseModel getClusterBillingHistoryGraph(clusterId, opts)

Retrieve hourly cost datapoints of a specific Cluster for a specific billing cycle

User will receive hourly cost datapoints for a Cluster for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let clusterId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getClusterBillingHistoryGraph(clusterId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
clusterId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelClusterGraphBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDataSynthesisBillingHistory

TokenBasedBillingHistoryResponse getDataSynthesisBillingHistory(opts)

Retrieve Billing History of data synthesis for a specific Billing Cycle

User will receive billing history of data_synthesis for the specified billing cycle.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.getDataSynthesisBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

TokenBasedBillingHistoryResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDataSynthesisBillingHistoryGraph

DataSynthesisBillingHistoryDetailsResponseSchema getDataSynthesisBillingHistoryGraph(resourceId, opts)

Retrieve hourly cost datapoints of a Specific Data Synthesis for a specific

User will receive hourly cost datapoints for a data synthesis job for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. billing cycle

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getDataSynthesisBillingHistoryGraph(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

DataSynthesisBillingHistoryDetailsResponseSchema

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDataSynthesisHistoryForResource

DataSynthesisBillingHistoryDetailsResponseSchema getDataSynthesisHistoryForResource(resourceId, opts)

Retrieve billing history for a specific Data Synthesis resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | YYYY-MM-DDTHH:MM:SS
};
apiInstance.getDataSynthesisHistoryForResource(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	YYYY-MM-DDTHH:MM:SS	[optional]

Return type

DataSynthesisBillingHistoryDetailsResponseSchema

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getFineTuningBillingHistory

WorkloadBillingHistoryResponse getFineTuningBillingHistory(opts)

Retrieve Billing History of model evaluation for a specific Billing Cycle

User will receive billing history of fine_tuning for the specified billing cycle.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.getFineTuningBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

WorkloadBillingHistoryResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getFineTuningBillingHistoryGraph

ResourceLevelVolumeGraphBillingDetailsResponseModel getFineTuningBillingHistoryGraph(resourceId, opts)

Retrieve hourly cost datapoints of a Specific Fine Tuning for a specific billing cycle

User will receive hourly cost datapoints for a Fine Tunings for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getFineTuningBillingHistoryGraph(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVolumeGraphBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getLastDayCost

LastDayCostResponse getLastDayCost()

GET: Last Day Cost

Retrieve the previous day's costs for instances, volumes, and clusters. Returns a breakdown of the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, click here

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
apiInstance.getLastDayCost().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

LastDayCostResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getModelEvaluationBillingHistory

TokenBasedBillingHistoryResponse getModelEvaluationBillingHistory(opts)

Retrieve Billing History of model evaluation for a specific Billing Cycle

User will receive billing history of model_evaluation for the specified billing cycle.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.getModelEvaluationBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

TokenBasedBillingHistoryResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getModelEvaluationBillingHistoryGraph

ModelEvaluationBillingHistoryDetailsResponseSchema getModelEvaluationBillingHistoryGraph(resourceId, opts)

Retrieve hourly cost datapoints of a Specific Model Evaluation for a specific

User will receive hourly cost datapoints for a model evaluation for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. billing cycle

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getModelEvaluationBillingHistoryGraph(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ModelEvaluationBillingHistoryDetailsResponseSchema

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getNotificationThreshold

OrganizationThresholdUpdateResponse getNotificationThreshold(thresholdId, payload)

Update: Subscribe or Unsubscribe Notification Threshold

By default, you are subscribed to all the threshold values and you will be receiving the email notification for these default thresholds values. `false` indicates that the user will no longer receive notifications for this specific threshold, whereas `true` signifies that the user will receive notification emails.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let thresholdId = 56; // Number | 
let payload = new HyperstackApi.SubscribeOrUnsubscribeUpdatePayload(); // SubscribeOrUnsubscribeUpdatePayload | 
apiInstance.getNotificationThreshold(thresholdId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
thresholdId	Number
payload	SubscribeOrUnsubscribeUpdatePayload

Return type

OrganizationThresholdUpdateResponse

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getResourceFineTuningBillingHistory

ResourceLevelVolumeBillingDetailsResponseModel getResourceFineTuningBillingHistory(resourceId, opts)

Retrieve Billing History of a Specific Fine Tuning for a specific Billing Cycle

Retrieve billing history of a specific Fine tuning for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Datetime should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Datetime should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getResourceFineTuningBillingHistory(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	Datetime should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Datetime should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVolumeBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getResourceModelEvaluationBillingHistory

ModelEvaluationBillingHistoryDetailsResponseSchema getResourceModelEvaluationBillingHistory(resourceId, opts)

Retrieve billing history for a specific Model Evaluation resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | YYYY-MM-DDTHH:MM:SS
};
apiInstance.getResourceModelEvaluationBillingHistory(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ModelEvaluationBillingHistoryDetailsResponseSchema

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getServerlessInferenceBillingHistoryGraph

ServerlessInferencedBillingHistoryDetailsResponseSchema getServerlessInferenceBillingHistoryGraph(resourceId, opts)

Retrieve hourly cost datapoints of a Specific Serverless Inference for a specific

User will receive hourly cost datapoints for a serverless inference for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. billing cycle

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getServerlessInferenceBillingHistoryGraph(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ServerlessInferencedBillingHistoryDetailsResponseSchema

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getServerlessInferencesBillingHistory

ServerlessInferencedBillingHistoryDetailsResponseSchema getServerlessInferencesBillingHistory(resourceId, opts)

Retrieve billing history for a specific Serverless Inference resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let resourceId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | YYYY-MM-DDTHH:MM:SS
};
apiInstance.getServerlessInferencesBillingHistory(resourceId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
resourceId	Number
startDate	String	YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ServerlessInferencedBillingHistoryDetailsResponseSchema

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSnapshotBillingHistory

ResourceLevelVolumeBillingDetailsResponseModel getSnapshotBillingHistory(snapshotId, opts)

Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle

Retrieve billing history of a specific Snapshot for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let snapshotId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Datetime should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Datetime should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getSnapshotBillingHistory(snapshotId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
snapshotId	Number
startDate	String	Datetime should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Datetime should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVolumeBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSnapshotBillingHistoryGraph

ResourceLevelVolumeGraphBillingDetailsResponseModel getSnapshotBillingHistoryGraph(snapshotId, opts)

Retrieve hourly cost datapoints of a Specific Snapshot for a specific billing cycle

User will receive hourly cost datapoints for a Snapshot for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let snapshotId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getSnapshotBillingHistoryGraph(snapshotId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
snapshotId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVolumeGraphBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getUsage

BillingMetricesResponse getUsage(opts)

GET: Billing usage

Retrieve active billing metrics for the organization's resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, click here

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'deleted': "deleted_example", // String | `true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)
  'environment': "environment_example" // String | Filter resources by environment ID or Name
};
apiInstance.getUsage(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
deleted	String	`true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)	[optional]
environment	String	Filter resources by environment ID or Name	[optional]

Return type

BillingMetricesResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getUserBillingHistory

OrganizationLevelBillingHistoryResponseModel getUserBillingHistory(opts)

Retrieve Billing History for a specific Billing Cycle

User will receive billing history for the specified billing cycle. This data will include 'incurred_bill', 'non_discounted_bill', 'vm_cost', 'volume_cost'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'graph': "graph_example" // String | Set this value to \"true\" for getting graph value
};
apiInstance.getUserBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
graph	String	Set this value to "true" for getting graph value	[optional]

Return type

OrganizationLevelBillingHistoryResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMBillingDetails

ResourceLevelVMBillingDetailsResponseModel getVMBillingDetails(vmId, opts)

Retrieve Billing History of a Specific Virtual Machine for a specific Billing Cycle

User will receive billing history of a specific Virtual Machine for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'non_discounted_price_per_hour', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'usage_time_ACTIVE', 'usage_time_SHUTOFF', 'usage_time_HIBERNATED'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let vmId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVMBillingDetails(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVMBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMBillingEvents

ResourceBillingEventsHistoryResponse getVMBillingEvents(vmId, opts)

Retrieve VM billing events history

User will receive vm billing events history

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let vmId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVMBillingEvents(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceBillingEventsHistoryResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMBillingGraph

ResourceLevelVmGraphBillingDetailsResponseModel getVMBillingGraph(vmId, opts)

Retrieve hourly cost datapoints of a Specific Virtual Machine for a specific billing cycle

User will receive hourly cost datapoints for a VM for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let vmId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVMBillingGraph(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVmGraphBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMBillingHistory

ResourceLevelVmBillingHistoryResponseModel getVMBillingHistory(opts)

Retrieve Billing History of Virtual Machine for a specific Billing Cycle

User will receive billing history of virtual machine for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.getVMBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

ResourceLevelVmBillingHistoryResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMSubResourceCosts

SubResourcesCostsResponseModel getVMSubResourceCosts(vmId, opts)

Retrieve Total Costs and Non Discount Costs for Sub Resources

User will get total costs and non_discount costs of sub resources on a specific Virtual Machine for the specified billing cycle. on a Specific VM for the Specified Billing Cycle

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let vmId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVMSubResourceCosts(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

SubResourcesCostsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMSubResourceGraph

SubResourcesGraphResponseModel getVMSubResourceGraph(vmId, opts)

Retrieve Sub-Resources Historical Cost datapoints of a Virtual

User will receive sub-resources historical cost datapoints for a VM sub resources for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. Machine sub resources for a specific billing cycle

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let vmId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVMSubResourceGraph(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

SubResourcesGraphResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVolumeBillingDetails

ResourceLevelVolumeBillingDetailsResponseModel getVolumeBillingDetails(volumeId, opts)

Retrieve Billing History of a Specific Volume for a specific Billing Cycle

Retrieve billing history of a specific Volume for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let volumeId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVolumeBillingDetails(volumeId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
volumeId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVolumeBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVolumeBillingEvents

ResourceBillingEventsHistoryResponse getVolumeBillingEvents(volumeId, opts)

Retrieve Volume billing events history

User will receive volume billing events history

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let volumeId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVolumeBillingEvents(volumeId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
volumeId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceBillingEventsHistoryResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVolumeBillingHistory

ResourceLevelVolumeBillingHistoryResponseModel getVolumeBillingHistory(opts)

Retrieve Billing History of Volume for a specific Billing Cycle

User will receive billing history of volumes for thespecified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.getVolumeBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

ResourceLevelVolumeBillingHistoryResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVolumeBillingHistoryGraph

ResourceLevelVolumeGraphBillingDetailsResponseModel getVolumeBillingHistoryGraph(volumeId, opts)

Retrieve hourly cost datapoints of a Specific Volume for a specific billing cycle

User will receive hourly cost datapoints for a Volume for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let volumeId = 56; // Number | 
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example" // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
};
apiInstance.getVolumeBillingHistoryGraph(volumeId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
volumeId	Number
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]

Return type

ResourceLevelVolumeGraphBillingDetailsResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listBillingContractHistory

listBillingContractHistory(opts)

Retrieve Billing History of Contract for a specific Billing Cycle

User will receive billing history of contracts for the specified billing cycle. This data will include 'description', gpu_type','infrahub_id', 'status', 'incurred_bill', 'price_per_hour'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example" // String | Search by Contract \"Description\" or \"ID\"
};
apiInstance.listBillingContractHistory(opts).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by Contract "Description" or "ID"	[optional]

Return type

null (empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listBucketBillingHistory

ResourceLevelBucketBillingHistoryResponseModel listBucketBillingHistory(opts)

Retrieve Billing History of a Bucket for a specific Billing Cycle

User will receive billing history of buckets for thespecified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.listBucketBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

ResourceLevelBucketBillingHistoryResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listClustersBillingHistory

ResourceLevelClusterBillingHistoryResponseModel listClustersBillingHistory(opts)

Retrieve Billing History of Clusters for a specific Billing Cycle

User will receive billing history of clusters for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.listClustersBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

ResourceLevelClusterBillingHistoryResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listOrgNotificationThresholds

OrganizationThresholdsResponse listOrgNotificationThresholds()

GET: All Thresholds for Organization

Retrieve all the notification thresholds for an organization.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
apiInstance.listOrgNotificationThresholds().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

OrganizationThresholdsResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listServerlessInferenceBillingHistory

TokenBasedBillingHistoryResponse listServerlessInferenceBillingHistory(opts)

Retrieve Billing History of serverless inference for a specific Billing Cycle

User will receive billing history of serverless_inference for the specified billing cycle.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.listServerlessInferenceBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

TokenBasedBillingHistoryResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listSnapshotBillingHistory

ResourceLevelVolumeBillingHistoryResponseModel listSnapshotBillingHistory(opts)

Retrieve Billing History of Snapshot for a specific Billing Cycle

User will receive billing history of snapshots for thespecified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour'

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new HyperstackApi.BillingApi();
let opts = {
  'startDate': "startDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'endDate': "endDate_example", // String | Date should be formatted in YYYY-MM-DDTHH:MM:SS
  'search': "search_example", // String | Search by resource \"Name\" or \"ID\"
  'perPage': 56, // Number | Number of items to return per page
  'page': 56 // Number | Page number
};
apiInstance.listSnapshotBillingHistory(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
startDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
endDate	String	Date should be formatted in YYYY-MM-DDTHH:MM:SS	[optional]
search	String	Search by resource "Name" or "ID"	[optional]
perPage	Number	Number of items to return per page	[optional]
page	Number	Page number	[optional]

Return type

ResourceLevelVolumeBillingHistoryResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

BillingApi.md

Latest commit

History

BillingApi.md

File metadata and controls

HyperstackApi.BillingApi

bucketsBillingHistoryHourlyChart

Example

Parameters

Return type

Authorization

HTTP request headers

getBucketBillingHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getClusterBillingHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getClusterBillingHistoryGraph

Example

Parameters

Return type

Authorization

HTTP request headers

getDataSynthesisBillingHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getDataSynthesisBillingHistoryGraph

Example

Parameters

Return type

Authorization

HTTP request headers

getDataSynthesisHistoryForResource

Example

Parameters

Return type

Authorization

HTTP request headers

getFineTuningBillingHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getFineTuningBillingHistoryGraph

Example

Parameters

Return type

Authorization

HTTP request headers

getLastDayCost

Example

Parameters

Return type

Authorization

HTTP request headers

getModelEvaluationBillingHistory

Example

Parameters

Return type

Authorization

HTTP request headers

getModelEvaluationBillingHistoryGraph

Example

Parameters

Return type

Authorization

HTTP request headers

getNotificationThreshold