@flexprice/sdk 2.1.30 → 2.1.33

package/docs/sdk/models/subscription-schedule-response.md

@@ -16,12 +16,12 @@ let value: SubscriptionScheduleResponse = {};
 | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
 | `canBeCancelled`                                                                               | *boolean*                                                                                      | :heavy_minus_sign:                                                                             | can_be_cancelled indicates if the schedule can be cancelled                                    |
 | `cancelledAt`                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)  | :heavy_minus_sign:                                                                             | cancelled_at is when the schedule was cancelled                                                |
-| `configuration`                                                                                | [models.Configuration](../../sdk/models/configuration.md)                                      | :heavy_minus_sign:                                                                             | configuration contains type-specific configuration (e.g., target_plan_id for plan changes)     |
+| `configuration`                                                                                | Record<string, *any*>                                                                          | :heavy_minus_sign:                                                                             | configuration contains type-specific configuration (e.g., target_plan_id for plan changes)     |
 | `createdAt`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)  | :heavy_minus_sign:                                                                             | created_at timestamp                                                                           |
 | `daysUntilExecution`                                                                           | *number*                                                                                       | :heavy_minus_sign:                                                                             | days_until_execution is the number of days until execution                                     |
 | `errorMessage`                                                                                 | *string*                                                                                       | :heavy_minus_sign:                                                                             | error_message contains the error if execution failed                                           |
 | `executedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)  | :heavy_minus_sign:                                                                             | executed_at is when the schedule was executed                                                  |
-| `executionResult`                                                                              | [models.ExecutionResult](../../sdk/models/execution-result.md)                                 | :heavy_minus_sign:                                                                             | execution_result contains type-specific execution result                                       |
+| `executionResult`                                                                              | Record<string, *any*>                                                                          | :heavy_minus_sign:                                                                             | execution_result contains type-specific execution result                                       |
 | `id`                                                                                           | *string*                                                                                       | :heavy_minus_sign:                                                                             | id of the schedule                                                                             |
 | `metadata`                                                                                     | Record<string, *string*>                                                                       | :heavy_minus_sign:                                                                             | metadata from the schedule                                                                     |
 | `scheduleType`                                                                                 | [models.SubscriptionScheduleChangeType](../../sdk/models/subscription-schedule-change-type.md) | :heavy_minus_sign:                                                                             | N/A                                                                                            |

package/docs/sdk/models/update-entitlement-request.md

@@ -10,18 +10,18 @@ let value: UpdateEntitlementRequest = {};
 
 ## Fields
 
-| Field                                                                                                                                       | Type                                                                                                                                        | Required                                                                                                                                    | Description                                                                                                                                 |
-| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| `aggregationMode`                                                                                                                           | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                                                       | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `clearGrantConfig`                                                                                                                          | *boolean*                                                                                                                                   | :heavy_minus_sign:                                                                                                                          | Grant config — nil fields leave the current value alone.<br/>ClearGrantConfig=true wipes the whole grant config (back to a legacy entitlement). |
-| `configValue`                                                                                                                               | Record<string, *any*>                                                                                                                       | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `grantAllocationBehavior`                                                                                                                   | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md)                                      | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `grantDurationUnit`                                                                                                                         | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)                                                  | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `grantDurationValue`                                                                                                                        | *number*                                                                                                                                    | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `grantMeasure`                                                                                                                              | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md)                                                             | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `grantQuota`                                                                                                                                | *string*                                                                                                                                    | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `isEnabled`                                                                                                                                 | *boolean*                                                                                                                                   | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `isSoftLimit`                                                                                                                               | *boolean*                                                                                                                                   | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `staticValue`                                                                                                                               | *string*                                                                                                                                    | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `usageLimit`                                                                                                                                | *number*                                                                                                                                    | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
-| `usageResetPeriod`                                                                                                                          | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)                                                    | :heavy_minus_sign:                                                                                                                          | N/A                                                                                                                                         |
+| Field                                                                                                  | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `aggregationMode`                                                                                      | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md)                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `configValue`                                                                                          | Record<string, *any*>                                                                                  | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantAllocationBehavior`                                                                              | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md) | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantDurationUnit`                                                                                    | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md)             | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantDurationValue`                                                                                   | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantMeasure`                                                                                         | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md)                        | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantQuota`                                                                                           | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `grantUnlimited`                                                                                       | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `isEnabled`                                                                                            | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `isSoftLimit`                                                                                          | *boolean*                                                                                              | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `staticValue`                                                                                          | *string*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `usageLimit`                                                                                           | *number*                                                                                               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |
+| `usageResetPeriod`                                                                                     | [models.EntitlementUsageResetPeriod](../../sdk/models/entitlement-usage-reset-period.md)               | :heavy_minus_sign:                                                                                     | N/A                                                                                                    |

package/docs/sdk/models/usage-analytic-item.md

@@ -50,6 +50,7 @@ let value: UsageAnalyticItem = {
 | `currency`                                                                                                                                         | *string*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                 | N/A                                                                                                                                                |
 | `eventCount`                                                                                                                                       | *number*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                 | Number of events that contributed to this aggregation                                                                                              |
 | `eventName`                                                                                                                                        | *string*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                 | N/A                                                                                                                                                |
+| `externalCustomerId`                                                                                                                               | *string*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                 | Populated only when "external_customer_id" is a group_by dimension                                                                                 |
 | `feature`                                                                                                                                          | [models.Feature](../../sdk/models/feature.md)                                                                                                      | :heavy_minus_sign:                                                                                                                                 | N/A                                                                                                                                                |
 | `featureId`                                                                                                                                        | *string*                                                                                                                                           | :heavy_minus_sign:                                                                                                                                 | N/A                                                                                                                                                |
 | `group`                                                                                                                                            | [models.GroupGroup](../../sdk/models/group-group.md)                                                                                               | :heavy_minus_sign:                                                                                                                                 | N/A                                                                                                                                                |

package/docs/sdk/models/variable-type.md

@@ -0,0 +1,17 @@
+# VariableType
+
+## Example Usage
+
+```typescript
+import { VariableType } from "@flexprice/sdk/sdk/models";
+
+let value: VariableType = "number";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"date_range" | "string" | "string_list" | "number" | "enum" | "boolean" | Unrecognized<string>
+```

package/docs/sdk/models/view-query-request.md

@@ -0,0 +1,15 @@
+# ViewQueryRequest
+
+## Example Usage
+
+```typescript
+import { ViewQueryRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ViewQueryRequest = {};
+```
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `variables`                | Record<string, *string*[]> | :heavy_minus_sign:         | N/A                        |

package/docs/sdk/models/view-response.md

@@ -0,0 +1,18 @@
+# ViewResponse
+
+## Example Usage
+
+```typescript
+import { ViewResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ViewResponse = {};
+```
+
+## Fields
+
+| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `definition`                                                                    | [models.AnalyticsViewDefinition](../../sdk/models/analytics-view-definition.md) | :heavy_minus_sign:                                                              | N/A                                                                             |
+| `id`                                                                            | *string*                                                                        | :heavy_minus_sign:                                                              | N/A                                                                             |
+| `name`                                                                          | *string*                                                                        | :heavy_minus_sign:                                                              | N/A                                                                             |
+| `version`                                                                       | *number*                                                                        | :heavy_minus_sign:                                                              | N/A                                                                             |

package/docs/sdks/analytics/README.md

@@ -0,0 +1,329 @@
+# Analytics
+
+## Overview
+
+### Available Operations
+
+* [queryAnalytics](#queryanalytics) - Run an ad-hoc analytics query
+* [getRevenueAnalytics](#getrevenueanalytics) - Query revenue analytics
+* [createAnalyticsView](#createanalyticsview) - Create an analytics view
+* [queryAnalyticsView](#queryanalyticsview) - Query an analytics view
+
+## queryAnalytics
+
+Resolves the given view definition against the supplied variables and executes it.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="queryAnalytics" method="post" path="/analytics/query" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.analytics.queryAnalytics({
+    definition: {
+      metrics: [
+        "usage_quantity",
+      ],
+      shape: "breakdown",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { analyticsQueryAnalytics } from "@flexprice/sdk/funcs/analytics-query-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: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await analyticsQueryAnalytics(flexprice, {
+    definition: {
+      metrics: [
+        "usage_quantity",
+      ],
+      shape: "breakdown",
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("analyticsQueryAnalytics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.AnalyticsQueryRequest](../../sdk/models/analytics-query-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.AnalyticsQueryResult](../../sdk/models/analytics-query-result.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## getRevenueAnalytics
+
+Aggregates revenue_facts by the requested dimensions at day/period/total granularity. allocation_policy places whole-period charges on their booked day (billed) or spreads them across the period (amortized); include_adjustments breaks out true-up/overage/revert amounts as labeled rows. Requires the tenant's revenue analytics setting.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getRevenueAnalytics" method="post" path="/analytics/revenue" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.analytics.getRevenueAnalytics({
+    startTime: new Date("2026-09-19T08:36:56.747Z"),
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { analyticsGetRevenueAnalytics } from "@flexprice/sdk/funcs/analytics-get-revenue-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: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await analyticsGetRevenueAnalytics(flexprice, {
+    startTime: new Date("2026-09-19T08:36:56.747Z"),
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("analyticsGetRevenueAnalytics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.RevenueAnalyticsRequest](../../sdk/models/revenue-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.RevenueAnalyticsResponse](../../sdk/models/revenue-analytics-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 403                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## createAnalyticsView
+
+Persists a named view definition that can later be queried by ID.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createAnalyticsView" method="post" path="/analytics/views" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.analytics.createAnalyticsView({
+    definition: {
+      metrics: [
+        "event_count",
+      ],
+      shape: "breakdown",
+    },
+    name: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { analyticsCreateAnalyticsView } from "@flexprice/sdk/funcs/analytics-create-analytics-view.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: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await analyticsCreateAnalyticsView(flexprice, {
+    definition: {
+      metrics: [
+        "event_count",
+      ],
+      shape: "breakdown",
+    },
+    name: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("analyticsCreateAnalyticsView failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.CreateViewRequest](../../sdk/models/create-view-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.ViewResponse](../../sdk/models/view-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## queryAnalyticsView
+
+Resolves the view's definition against the supplied variables and executes it.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="queryAnalyticsView" method="post" path="/analytics/views/{id}/query" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.analytics.queryAnalyticsView("<id>", {});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { analyticsQueryAnalyticsView } from "@flexprice/sdk/funcs/analytics-query-analytics-view.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: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await analyticsQueryAnalyticsView(flexprice, "<id>", {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("analyticsQueryAnalyticsView failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | View ID                                                                                                                                                                        |
+| `body`                                                                                                                                                                         | [models.ViewQueryRequest](../../sdk/models/view-query-request.md)                                                                                                              | :heavy_check_mark:                                                                                                                                                             | View query 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.AnalyticsQueryResult](../../sdk/models/analytics-query-result.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/checkout/README.md

@@ -7,6 +7,7 @@
 * [createCheckoutSession](#createcheckoutsession) - Create checkout session
 * [getCheckoutSession](#getcheckoutsession) - Get checkout session
 * [deleteCheckoutSession](#deletecheckoutsession) - Delete checkout session
+* [cancelCheckoutSession](#cancelcheckoutsession) - Cancel checkout session
 
 ## createCheckoutSession
 
@@ -24,7 +25,7 @@ const flexprice = new Flexprice({
 
 async function run() {
   const result = await flexprice.checkout.createCheckoutSession({
-    action: "add_addon",
+    action: "pay_invoice",
     customerExternalId: "<id>",
     paymentProvider: "razorpay",
   });
@@ -51,7 +52,7 @@ const flexprice = new FlexpriceCore({
 
 async function run() {
   const res = await checkoutCreateCheckoutSession(flexprice, {
-    action: "add_addon",
+    action: "pay_invoice",
     customerExternalId: "<id>",
     paymentProvider: "razorpay",
   });
@@ -227,4 +228,75 @@ run();
 | -------------------------- | -------------------------- | -------------------------- |
 | models.ErrorsErrorResponse | 404                        | application/json           |
 | models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## cancelCheckoutSession
+
+Cancel checkout session
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="cancelCheckoutSession" method="post" path="/checkout/sessions/{id}/cancel" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.checkout.cancelCheckoutSession("<id>");
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { checkoutCancelCheckoutSession } from "@flexprice/sdk/funcs/checkout-cancel-checkout-session.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: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await checkoutCancelCheckoutSession(flexprice, "<id>");
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("checkoutCancelCheckoutSession failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Checkout session 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.CheckoutSessionResponse](../../sdk/models/checkout-session-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
 | models.SDKError            | 4XX, 5XX                   | \*/\*                      |

package/docs/sdks/invoices/README.md

@@ -94,6 +94,7 @@ run();
 ## createInvoice
 
 Use when creating a manual or one-off invoice (e.g. custom charge or non-recurring billing). Invoice is created in draft; finalize when ready.
+Pass a `checkout` object to gate the invoice behind a hosted payment session: the invoice stays DRAFT with no invoice number, and the response carries `checkout_session.payment_action.url` for the customer to pay. It finalizes only when the payment webhook lands; if the session expires the invoice is voided and archived. Poll `GET /checkout/sessions/{id}` until `terminal` is true. One-off invoices only.
 
 ### Example Usage