@flexprice/sdk 2.1.19 → 2.1.24

package/docs/sdk/models/checkout-session-response.md

@@ -0,0 +1,42 @@
+# CheckoutSessionResponse
+
+## Example Usage
+
+```typescript
+import { CheckoutSessionResponse } from "@flexprice/sdk/sdk/models";
+
+let value: CheckoutSessionResponse = {};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                    | Type                                                                                                                                                                                                     | Required                                                                                                                                                                                                 | Description                                                                                                                                                                                              |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `action`                                                                                                                                                                                                 | [models.CheckoutAction](../../sdk/models/checkout-action.md)                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `cancelUrl`                                                                                                                                                                                              | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `cancelledAt`                                                                                                                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `checkoutInvoiceId`                                                                                                                                                                                      | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | CheckoutInvoiceID and CheckoutPaymentID are set once the apply step<br/>creates the corresponding Flexprice entities (completed sessions only).                                                          |
+| `checkoutPaymentId`                                                                                                                                                                                      | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `checkoutStatus`                                                                                                                                                                                         | [models.CheckoutStatus](../../sdk/models/checkout-status.md)                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `completedAt`                                                                                                                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `configuration`                                                                                                                                                                                          | [models.CheckoutJSONBCheckoutConfiguration](../../sdk/models/checkout-jsonb-checkout-configuration.md)                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `createdAt`                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `createdBy`                                                                                                                                                                                              | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `customerId`                                                                                                                                                                                             | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `environmentId`                                                                                                                                                                                          | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `expiresAt`                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | ExpiresAt is required. A Temporal timer fires at this time for any<br/>session still in initiated\|pending, marking it expired. The caller<br/>must create a new session after expiry (expire-and-restart model). |
+| `failureReason`                                                                                                                                                                                          | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | FailureReason is a human-readable string set on failed sessions.                                                                                                                                         |
+| `failureUrl`                                                                                                                                                                                             | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `id`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `idempotencyKey`                                                                                                                                                                                         | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | IdempotencyKey is caller-supplied. It is unique only while the session<br/>is active (initiated\|pending). The same key may be reused once the<br/>session reaches a terminal state (completed\|failed\|expired). |
+| `metadata`                                                                                                                                                                                               | Record<string, *string*>                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `paymentAction`                                                                                                                                                                                          | [models.PaymentAction](../../sdk/models/payment-action.md)                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `paymentProvider`                                                                                                                                                                                        | [models.CheckoutPaymentProvider](../../sdk/models/checkout-payment-provider.md)                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `paymentProviderConfig`                                                                                                                                                                                  | [models.CheckoutJSONBCheckoutPaymentProviderConfig](../../sdk/models/checkout-jsonb-checkout-payment-provider-config.md)                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `providerResult`                                                                                                                                                                                         | [models.CheckoutJSONBCheckoutProviderResult](../../sdk/models/checkout-jsonb-checkout-provider-result.md)                                                                                                | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `result`                                                                                                                                                                                                 | [models.CheckoutJSONBCheckoutResult](../../sdk/models/checkout-jsonb-checkout-result.md)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `status`                                                                                                                                                                                                 | [models.Status](../../sdk/models/status.md)                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `successUrl`                                                                                                                                                                                             | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | Redirect URLs sent to the payment provider. The provider redirects the<br/>user browser to the appropriate URL after the payment flow completes.                                                         |
+| `tenantId`                                                                                                                                                                                               | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `updatedAt`                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |
+| `updatedBy`                                                                                                                                                                                              | *string*                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                       | N/A                                                                                                                                                                                                      |

package/docs/sdk/models/checkout-status.md

@@ -0,0 +1,17 @@
+# CheckoutStatus
+
+## Example Usage
+
+```typescript
+import { CheckoutStatus } from "@flexprice/sdk/sdk/models";
+
+let value: CheckoutStatus = "completed";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
+```
+
+## Values
+
+```typescript
+"initiated" | "pending" | "completed" | "failed" | "expired" | Unrecognized<string>
+```

package/docs/sdk/models/collection-method.md

@@ -6,10 +6,12 @@
 import { CollectionMethod } from "@flexprice/sdk/sdk/models";
 
 let value: CollectionMethod = "send_invoice";
+
+// Open enum: unrecognized values are captured as Unrecognized<string>
 ```
 
 ## Values
 
 ```typescript
-"charge_automatically" | "send_invoice"
+"charge_automatically" | "send_invoice" | Unrecognized<string>
 ```

package/docs/sdk/models/config-value.md

@@ -0,0 +1,14 @@
+# ConfigValue
+
+## Example Usage
+
+```typescript
+import { ConfigValue } from "@flexprice/sdk/sdk/models";
+
+let value: ConfigValue = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/sdk/models/coupon-association-response.md

@@ -5,14 +5,46 @@
 ```typescript
 import { CouponAssociationResponse } from "@flexprice/sdk/sdk/models";
 
-let value: CouponAssociationResponse = {};
+let value: CouponAssociationResponse = {
+  subscriptionLineItem: {
+    price: {
+      addon: {
+        prices: [
+          {
+            addon: {},
+            meter: {
+              createdAt: new Date("2024-03-20T15:04:05Z"),
+              eventName: "api_request",
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              name: "API Usage Meter",
+              status: "published",
+              tenantId: "tenant123",
+              updatedAt: new Date("2024-03-20T15:04:05Z"),
+            },
+            plan: {},
+          },
+        ],
+      },
+      meter: {
+        createdAt: new Date("2024-03-20T15:04:05Z"),
+        eventName: "api_request",
+        id: "550e8400-e29b-41d4-a716-446655440000",
+        name: "API Usage Meter",
+        status: "published",
+        tenantId: "tenant123",
+        updatedAt: new Date("2024-03-20T15:04:05Z"),
+      },
+      plan: {},
+    },
+  },
+};
 ```
 
 ## Fields
 
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `coupon`                                                                                      | [models.Coupon](../../sdk/models/coupon.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `coupon`                                                                                      | [models.CouponResponse](../../sdk/models/coupon-response.md)                                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `couponId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `createdBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
@@ -23,6 +55,7 @@ let value: CouponAssociationResponse = {};
 | `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `subscriptionId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | Mandatory                                                                                     |
+| `subscriptionLineItem`                                                                        | [models.SubscriptionLineItemResponse](../../sdk/models/subscription-line-item-response.md)    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `subscriptionLineItemId`                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | Optional                                                                                      |
 | `subscriptionPhaseId`                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | Optional                                                                                      |
 | `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/create-addon-response.md

@@ -63,6 +63,7 @@ let value: CreateAddonResponse = {
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
 | `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `createdBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `creditGrants`                                                                                | [models.CreditGrantResponse](../../sdk/models/credit-grant-response.md)[]                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `description`                                                                                 | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `entitlements`                                                                                | [models.EntitlementResponse](../../sdk/models/entitlement-response.md)[]                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/create-alert-settings-request.md

@@ -0,0 +1,23 @@
+# CreateAlertSettingsRequest
+
+## Example Usage
+
+```typescript
+import { CreateAlertSettingsRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateAlertSettingsRequest = {
+  config: {},
+  entityId: "<id>",
+  entityType: "group",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                  | Type                                                                                                                                                                                   | Required                                                                                                                                                                               | Description                                                                                                                                                                            |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `config`                                                                                                                                                                               | [models.AlertSettings](../../sdk/models/alert-settings.md)                                                                                                                             | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |
+| `entityId`                                                                                                                                                                             | *string*                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                     | entity_id is the id of the monitored entity: subscription id, subscription_line_item id, or<br/>group id, matching entity_type.                                                        |
+| `entityType`                                                                                                                                                                           | [models.AlertEntityType](../../sdk/models/alert-entity-type.md)                                                                                                                        | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |
+| `parentEntityId`                                                                                                                                                                       | *string*                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                     | parent_entity_id is the subscription id that owns a line-item or group alert. Required when<br/>entity_type is "subscription_line_item" or "group"; omitted for subscription-level alerts. |
+| `parentEntityType`                                                                                                                                                                     | [models.AlertEntityType](../../sdk/models/alert-entity-type.md)                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                     | N/A                                                                                                                                                                                    |

package/docs/sdk/models/create-checkout-session-request.md

@@ -0,0 +1,28 @@
+# CreateCheckoutSessionRequest
+
+## Example Usage
+
+```typescript
+import { CreateCheckoutSessionRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateCheckoutSessionRequest = {
+  action: "modify_subscription",
+  customerExternalId: "<id>",
+  paymentProvider: "razorpay",
+};
+```
+
+## Fields
+
+| Field                                                                                        | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `action`                                                                                     | [models.CheckoutAction](../../sdk/models/checkout-action.md)                                 | :heavy_check_mark:                                                                           | N/A                                                                                          |
+| `cancelUrl`                                                                                  | *string*                                                                                     | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `configuration`                                                                              | [models.CheckoutConfiguration](../../sdk/models/checkout-configuration.md)                   | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `customerExternalId`                                                                         | *string*                                                                                     | :heavy_check_mark:                                                                           | N/A                                                                                          |
+| `failureUrl`                                                                                 | *string*                                                                                     | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `idempotencyKey`                                                                             | *string*                                                                                     | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `metadata`                                                                                   | Record<string, *string*>                                                                     | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `paymentProvider`                                                                            | [models.CheckoutPaymentProvider](../../sdk/models/checkout-payment-provider.md)              | :heavy_check_mark:                                                                           | N/A                                                                                          |
+| `paymentProviderConfig`                                                                      | [models.CheckoutPaymentProviderConfig](../../sdk/models/checkout-payment-provider-config.md) | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `successUrl`                                                                                 | *string*                                                                                     | :heavy_minus_sign:                                                                           | N/A                                                                                          |

package/docs/sdk/models/create-credit-grant-request.md

@@ -9,7 +9,7 @@ let value: CreateCreditGrantRequest = {
   cadence: "ONETIME",
   credits: "<value>",
   name: "<value>",
-  scope: "SUBSCRIPTION",
+  scope: "ADDON",
 };
 ```
 
@@ -17,6 +17,7 @@ let value: CreateCreditGrantRequest = {
 
 | Field                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                              |
 | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `addonId`                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `cadence`                                                                                                                                                                                                                                                | [models.CreditGrantCadence](../../sdk/models/credit-grant-cadence.md)                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `conversionRate`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                       | amount in the currency =  number of credits * conversion_rate<br/>ex if conversion_rate is 1, then 1 USD = 1 credit<br/>ex if conversion_rate is 2, then 1 USD = 0.5 credits<br/>ex if conversion_rate is 0.5, then 1 USD = 2 credits                    |
 | `credits`                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |

package/docs/sdk/models/create-customer-request.md

@@ -9,6 +9,7 @@ import { CreateCustomerRequest } from "@flexprice/sdk/sdk/models";
 
 let value: CreateCustomerRequest = {
   externalId: "<id>",
+  name: "<value>",
 };
 ```
 
@@ -22,10 +23,13 @@ let value: CreateCustomerRequest = {
 | `addressLine2`                                                                                                                                                                                                | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_line2 is the secondary address line with maximum 255 characters                                                                                                                                       |
 | `addressPostalCode`                                                                                                                                                                                           | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_postal_code is the ZIP code or postal code with maximum 20 characters                                                                                                                                 |
 | `addressState`                                                                                                                                                                                                | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_state is the state, province, or region name with maximum 100 characters                                                                                                                              |
+| `contact`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | contact is an optional contact number for the customer (e.g. phone)                                                                                                                                           |
 | `email`                                                                                                                                                                                                       | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | email is the customer's email address and must be a valid email format if provided                                                                                                                            |
 | `externalId`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                            | external_id is the unique identifier from your system to reference this customer (required)                                                                                                                   |
 | `integrationEntityMapping`                                                                                                                                                                                    | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[]                                                                                               | :heavy_minus_sign:                                                                                                                                                                                            | integration_entity_mapping contains provider integration mappings for this customer                                                                                                                           |
 | `metadata`                                                                                                                                                                                                    | Record<string, *string*>                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | metadata contains additional key-value pairs for storing extra information                                                                                                                                    |
-| `name`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | name is the full name or company name of the customer                                                                                                                                                         |
+| `name`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                            | name is the full name or company name of the customer                                                                                                                                                         |
+| `onboardingWorkflowName`                                                                                                                                                                                      | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | onboarding_workflow_name is given if a custom onboarding workflow is to be triggered for this customer                                                                                                        |
 | `skipOnboardingWorkflow`                                                                                                                                                                                      | *boolean*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                            | skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered<br/>This is used internally when a customer is created via a workflow to prevent infinite loops<br/>Default: false |
-| `taxRateOverrides`                                                                                                                                                                                            | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                            | tax_rate_overrides contains tax rate configurations to be linked to this customer                                                                                                                             |
+| `taxRateOverrides`                                                                                                                                                                                            | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                            | tax_rate_overrides contains tax rate configurations to be linked to this customer                                                                                                                             |
+| `timezone`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata", "America/New_York")<br/>Defaults to "UTC" if not provided                                                                                 |

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

@@ -15,11 +15,17 @@ let value: CreateEntitlementRequest = {
 
 | 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                                                                                           |
 | `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `entityId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `entityType`                                                                                  | [models.EntitlementEntityType](../../sdk/models/entitlement-entity-type.md)                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `featureId`                                                                                   | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
 | `featureType`                                                                                 | [models.FeatureType](../../sdk/models/feature-type.md)                                        | :heavy_check_mark:                                                                            | 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                                                                                           |
 | `parentEntitlementId`                                                                         | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/create-feature-request.md

@@ -13,7 +13,7 @@ let value: CreateFeatureRequest = {
     resetUsage: "BILLING_PERIOD",
   },
   name: "<value>",
-  type: "boolean",
+  type: "static",
 };
 ```
 

package/docs/sdk/models/create-invoice-request.md

@@ -16,34 +16,35 @@ let value: CreateInvoiceRequest = {
 
 ## Fields
 
-| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `amountDue`                                                                                        | *string*                                                                                           | :heavy_check_mark:                                                                                 | amount_due is the total amount that needs to be paid for this invoice                              |
-| `amountPaid`                                                                                       | *string*                                                                                           | :heavy_minus_sign:                                                                                 | amount_paid is the amount that has been paid towards this invoice                                  |
-| `billingPeriod`                                                                                    | *string*                                                                                           | :heavy_minus_sign:                                                                                 | billing_period is the period this invoice covers (e.g., "monthly", "yearly")                       |
-| `billingReason`                                                                                    | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md)                          | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
-| `coupons`                                                                                          | *string*[]                                                                                         | :heavy_minus_sign:                                                                                 | coupons                                                                                            |
-| `currency`                                                                                         | *string*                                                                                           | :heavy_check_mark:                                                                                 | currency is the three-letter ISO currency code (e.g., USD, EUR) for the invoice                    |
-| `customerId`                                                                                       | *string*                                                                                           | :heavy_check_mark:                                                                                 | customer_id is the unique identifier of the customer this invoice belongs to                       |
-| `description`                                                                                      | *string*                                                                                           | :heavy_minus_sign:                                                                                 | description is an optional text description of the invoice                                         |
-| `dueDate`                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)      | :heavy_minus_sign:                                                                                 | due_date is the date by which payment is expected                                                  |
-| `idempotencyKey`                                                                                   | *string*                                                                                           | :heavy_minus_sign:                                                                                 | idempotency_key is an optional key used to prevent duplicate invoice creation                      |
-| `invoiceCoupons`                                                                                   | [models.InvoiceCoupon](../../sdk/models/invoice-coupon.md)[]                                       | :heavy_minus_sign:                                                                                 | Invoice Coupons                                                                                    |
-| `invoiceNumber`                                                                                    | *string*                                                                                           | :heavy_minus_sign:                                                                                 | invoice_number is an optional human-readable identifier for the invoice                            |
-| `invoicePdfUrl`                                                                                    | *string*                                                                                           | :heavy_minus_sign:                                                                                 | invoice_pdf_url is the URL where customers can download the PDF version of this invoice            |
-| `invoiceStatus`                                                                                    | [models.InvoiceStatus](../../sdk/models/invoice-status.md)                                         | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
-| `invoiceType`                                                                                      | [models.InvoiceType](../../sdk/models/invoice-type.md)                                             | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
-| `issueDate`                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)      | :heavy_minus_sign:                                                                                 | issue_date overrides the user-facing date of the invoice.<br/>Defaults to created_at if not provided. |
-| `lineItemCoupons`                                                                                  | [models.InvoiceLineItemCoupon](../../sdk/models/invoice-line-item-coupon.md)[]                     | :heavy_minus_sign:                                                                                 | Invoice Line Item Coupons                                                                          |
-| `lineItems`                                                                                        | [models.CreateInvoiceLineItemRequest](../../sdk/models/create-invoice-line-item-request.md)[]      | :heavy_minus_sign:                                                                                 | line_items contains the individual items that make up this invoice                                 |
-| `metadata`                                                                                         | Record<string, *string*>                                                                           | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
-| `paymentStatus`                                                                                    | [models.PaymentStatus](../../sdk/models/payment-status.md)                                         | :heavy_minus_sign:                                                                                 | N/A                                                                                                |
-| `periodEnd`                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)      | :heavy_minus_sign:                                                                                 | period_end is the end date of the billing period                                                   |
-| `periodStart`                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)      | :heavy_minus_sign:                                                                                 | period_start is the start date of the billing period                                               |
-| `preparedTaxRates`                                                                                 | [models.TaxRateResponse](../../sdk/models/tax-rate-response.md)[]                                  | :heavy_minus_sign:                                                                                 | prepared_tax_rates contains the tax rates pre-resolved by the caller (e.g., billing service)       |
-| `subscriptionId`                                                                                   | *string*                                                                                           | :heavy_minus_sign:                                                                                 | subscription_id is the optional unique identifier of the subscription associated with this invoice |
-| `subtotal`                                                                                         | *string*                                                                                           | :heavy_check_mark:                                                                                 | subtotal is the amount before taxes and discounts are applied                                      |
-| `taxRateOverrides`                                                                                 | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                  | :heavy_minus_sign:                                                                                 | tax_rate_overrides is the tax rate overrides to be applied to the invoice                          |
-| `taxRates`                                                                                         | *string*[]                                                                                         | :heavy_minus_sign:                                                                                 | tax_rates                                                                                          |
-| `total`                                                                                            | *string*                                                                                           | :heavy_check_mark:                                                                                 | total is the total amount of the invoice including taxes and discounts                             |
-| `totalPrepaidApplied`                                                                              | *string*                                                                                           | :heavy_minus_sign:                                                                                 | total_prepaid_applied is the total amount of prepaid applied to this invoice.                      |
+| Field                                                                                                                                                                                                                                                                                            | Type                                                                                                                                                                                                                                                                                             | Required                                                                                                                                                                                                                                                                                         | Description                                                                                                                                                                                                                                                                                      |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `amountDue`                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | amount_due is the total amount that needs to be paid for this invoice                                                                                                                                                                                                                            |
+| `amountPaid`                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | amount_paid is the amount that has been paid towards this invoice                                                                                                                                                                                                                                |
+| `billingPeriod`                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | billing_period is the period this invoice covers (e.g., "monthly", "yearly")                                                                                                                                                                                                                     |
+| `billingReason`                                                                                                                                                                                                                                                                                  | [models.InvoiceBillingReason](../../sdk/models/invoice-billing-reason.md)                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
+| `coupons`                                                                                                                                                                                                                                                                                        | *string*[]                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | coupons                                                                                                                                                                                                                                                                                          |
+| `currency`                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | currency is the three-letter ISO currency code (e.g., USD, EUR) for the invoice                                                                                                                                                                                                                  |
+| `customerId`                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | customer_id is the unique identifier of the customer this invoice belongs to                                                                                                                                                                                                                     |
+| `description`                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | description is an optional text description of the invoice                                                                                                                                                                                                                                       |
+| `dueDate`                                                                                                                                                                                                                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | due_date is the date by which payment is expected                                                                                                                                                                                                                                                |
+| `forceSyncInvoice`                                                                                                                                                                                                                                                                               | *boolean*                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | force_sync_invoice, when true, attempts to synchronously sync this invoice to<br/>Moyasar (if enabled) before returning, instead of relying solely on the async<br/>Kafka + Temporal vendor-sync pipeline. Only honored by CreateOneOffInvoice.<br/>Best-effort: sync failures do not fail invoice creation. |
+| `idempotencyKey`                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | idempotency_key is an optional key used to prevent duplicate invoice creation                                                                                                                                                                                                                    |
+| `invoiceCoupons`                                                                                                                                                                                                                                                                                 | [models.InvoiceCoupon](../../sdk/models/invoice-coupon.md)[]                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | Invoice Coupons                                                                                                                                                                                                                                                                                  |
+| `invoiceNumber`                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | invoice_number is an optional human-readable identifier for the invoice                                                                                                                                                                                                                          |
+| `invoicePdfUrl`                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | invoice_pdf_url is the URL where customers can download the PDF version of this invoice                                                                                                                                                                                                          |
+| `invoiceStatus`                                                                                                                                                                                                                                                                                  | [models.InvoiceStatus](../../sdk/models/invoice-status.md)                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
+| `invoiceType`                                                                                                                                                                                                                                                                                    | [models.InvoiceType](../../sdk/models/invoice-type.md)                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
+| `issueDate`                                                                                                                                                                                                                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | issue_date overrides the user-facing date of the invoice.<br/>Defaults to created_at if not provided.                                                                                                                                                                                            |
+| `lineItemCoupons`                                                                                                                                                                                                                                                                                | [models.InvoiceLineItemCoupon](../../sdk/models/invoice-line-item-coupon.md)[]                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | Invoice Line Item Coupons                                                                                                                                                                                                                                                                        |
+| `lineItems`                                                                                                                                                                                                                                                                                      | [models.CreateInvoiceLineItemRequest](../../sdk/models/create-invoice-line-item-request.md)[]                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | line_items contains the individual items that make up this invoice                                                                                                                                                                                                                               |
+| `metadata`                                                                                                                                                                                                                                                                                       | Record<string, *string*>                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
+| `paymentStatus`                                                                                                                                                                                                                                                                                  | [models.PaymentStatus](../../sdk/models/payment-status.md)                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                                                                                              |
+| `periodEnd`                                                                                                                                                                                                                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | period_end is the end date of the billing period                                                                                                                                                                                                                                                 |
+| `periodStart`                                                                                                                                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | period_start is the start date of the billing period                                                                                                                                                                                                                                             |
+| `preparedTaxRates`                                                                                                                                                                                                                                                                               | [models.TaxRateResponse](../../sdk/models/tax-rate-response.md)[]                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | prepared_tax_rates contains the tax rates pre-resolved by the caller (e.g., billing service)                                                                                                                                                                                                     |
+| `subscriptionId`                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | subscription_id is the optional unique identifier of the subscription associated with this invoice                                                                                                                                                                                               |
+| `subtotal`                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | subtotal is the amount before taxes and discounts are applied                                                                                                                                                                                                                                    |
+| `taxRateOverrides`                                                                                                                                                                                                                                                                               | [models.TaxRateOverride](../../sdk/models/tax-rate-override.md)[]                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | tax_rate_overrides is the tax rate overrides to be applied to the invoice                                                                                                                                                                                                                        |
+| `taxRates`                                                                                                                                                                                                                                                                                       | *string*[]                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | tax_rates                                                                                                                                                                                                                                                                                        |
+| `total`                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                               | total is the total amount of the invoice including taxes and discounts                                                                                                                                                                                                                           |
+| `totalPrepaidApplied`                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                               | total_prepaid_applied is the total amount of prepaid applied to this invoice.                                                                                                                                                                                                                    |