# Costs ## Overview ### Available Operations * [createCostsheet](#createcostsheet) - Create costsheet * [getActiveCostsheet](#getactivecostsheet) - Get active costsheet * [getDetailedCostAnalytics](#getdetailedcostanalytics) - Get combined revenue and cost analytics * [queryCostsheet](#querycostsheet) - Query costsheets * [getCostsheet](#getcostsheet) - Get costsheet * [updateCostsheet](#updatecostsheet) - Update costsheet * [deleteCostsheet](#deletecostsheet) - Delete costsheet ## createCostsheet Use when setting up a new pricing configuration (e.g. a new product or region). Costsheets group prices and define the default for the environment. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.createCostsheet({ name: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsCreateCostsheet } from "@flexprice/sdk/funcs/costs-create-costsheet.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsCreateCostsheet(flexprice, { name: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsCreateCostsheet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.CreateCostsheetRequest](../../sdk/models/create-costsheet-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.CreateCostsheetResponse](../../sdk/models/create-costsheet-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 409 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getActiveCostsheet Use when you need the tenant's default pricing configuration (e.g. for checkout or plan display). Returns the active costsheet for the environment. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.getActiveCostsheet(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsGetActiveCostsheet } from "@flexprice/sdk/funcs/costs-get-active-costsheet.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsGetActiveCostsheet(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsGetActiveCostsheet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.CostsheetResponse](../../sdk/models/costsheet-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getDetailedCostAnalytics Use when building dashboards or reports that need revenue vs cost, ROI, and margin over a time period (e.g. finance views or executive summaries). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.getDetailedCostAnalytics({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsGetDetailedCostAnalytics } from "@flexprice/sdk/funcs/costs-get-detailed-cost-analytics.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsGetDetailedCostAnalytics(flexprice, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsGetDetailedCostAnalytics failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetCostAnalyticsRequest](../../sdk/models/get-cost-analytics-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetDetailedCostAnalyticsResponse](../../sdk/models/get-detailed-cost-analytics-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## queryCostsheet Use when listing or searching costsheets (e.g. admin catalog). Returns a paginated list; supports filtering and sorting. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.queryCostsheet({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsQueryCostsheet } from "@flexprice/sdk/funcs/costs-query-costsheet.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsQueryCostsheet(flexprice, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsQueryCostsheet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.CostsheetFilter](../../sdk/models/costsheet-filter.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ListCostsheetResponse](../../sdk/models/list-costsheet-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getCostsheet Use when you need to load a single costsheet (e.g. for editing or display). Supports optional expand for related prices. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.getCostsheet(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsGetCostsheet } from "@flexprice/sdk/funcs/costs-get-costsheet.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsGetCostsheet(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsGetCostsheet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Costsheet ID | | `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'prices') | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetCostsheetResponse](../../sdk/models/get-costsheet-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## updateCostsheet Use when changing costsheet name or metadata. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.updateCostsheet("", {}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsUpdateCostsheet } from "@flexprice/sdk/funcs/costs-update-costsheet.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsUpdateCostsheet(flexprice, "", {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsUpdateCostsheet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Costsheet ID | | `body` | [models.UpdateCostsheetRequest](../../sdk/models/update-costsheet-request.md) | :heavy_check_mark: | Costsheet configuration | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.UpdateCostsheetResponse](../../sdk/models/update-costsheet-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404, 409 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## deleteCostsheet Use when retiring a costsheet (e.g. end-of-life product). Soft-deletes; status set to deleted. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.costs.deleteCostsheet(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { costsDeleteCostsheet } from "@flexprice/sdk/funcs/costs-delete-costsheet.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await costsDeleteCostsheet(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("costsDeleteCostsheet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Costsheet ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.DeleteCostsheetResponse](../../sdk/models/delete-costsheet-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* |