@flexprice/sdk 2.1.26 → 2.1.33

package/docs/sdk/models/invoice-modify-response.md

@@ -0,0 +1,126 @@
+# InvoiceModifyResponse
+
+## Example Usage
+
+```typescript
+import { InvoiceModifyResponse } from "@flexprice/sdk/sdk/models";
+
+let value: InvoiceModifyResponse = {
+  invoice: {
+    subscription: {
+      couponAssociations: [
+        {
+          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: {},
+            },
+          },
+        },
+      ],
+      entitlements: [
+        {
+          feature: {
+            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"),
+            },
+          },
+        },
+      ],
+      latestInvoice: {
+        subscription: {
+          couponAssociations: [
+            {
+              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: {},
+                },
+              },
+            },
+          ],
+          entitlements: [
+            {
+              feature: {
+                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: {},
+        },
+      },
+      plan: {},
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                          | Type                                                           | Required                                                       | Description                                                    |
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
+| `invoice`                                                      | [models.InvoiceResponse](../../sdk/models/invoice-response.md) | :heavy_minus_sign:                                             | N/A                                                            |

package/docs/sdk/models/invoice-modify-type.md

@@ -0,0 +1,15 @@
+# InvoiceModifyType
+
+## Example Usage
+
+```typescript
+import { InvoiceModifyType } from "@flexprice/sdk/sdk/models";
+
+let value: InvoiceModifyType = "line_item";
+```
+
+## Values
+
+```typescript
+"line_item"
+```

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

@@ -128,10 +128,12 @@ let value: InvoiceResponse = {
 | `billingPeriod`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | billing_period describes the billing period this invoice covers (e.g., "January 2024", "Q1 2024")                                                                                                                                 |
 | `billingReason`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | billing_reason indicates why this invoice was generated (e.g., "subscription_billing", "manual_charge")                                                                                                                           |
 | `billingSequence`                                                                                                                                                                                                                 | *number*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | billing_sequence is the sequential number indicating the billing cycle for subscription invoices                                                                                                                                  |
+| `checkoutSession`                                                                                                                                                                                                                 | [models.CheckoutSessionResponse](../../sdk/models/checkout-session-response.md)                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `couponApplications`                                                                                                                                                                                                              | [models.CouponApplicationResponse](../../sdk/models/coupon-application-response.md)[]                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                | coupon_applications contains the coupon applications associated with this invoice (overrides embedded field)                                                                                                                      |
 | `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                                                                                                                                                                                                                               |
 | `currency`                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | currency is the three-letter ISO currency code (e.g., USD, EUR, GBP) that applies to all monetary amounts on this invoice                                                                                                         |
+| `customCurrency`                                                                                                                                                                                                                  | [models.CustomCurrency](../../sdk/models/custom-currency.md)                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `customer`                                                                                                                                                                                                                        | [models.CustomerResponse](../../sdk/models/customer-response.md)                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                | Customer response object containing all customer information                                                                                                                                                                      |
 | `customerId`                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | customer_id is the ID of the customer who will receive this invoice                                                                                                                                                               |
 | `description`                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | description is an optional description or notes about this invoice                                                                                                                                                                |
@@ -156,11 +158,14 @@ let value: InvoiceResponse = {
 | `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 covered by this invoice                                                                                                                                                      |
 | `recalculatedInvoiceId`                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | recalculated_invoice_id is the ID of the replacement invoice created when this invoice was voided and recalculated.<br/>When set, it forms a parent→child link from this (voided) invoice to the new replacement invoice.         |
 | `refundedAmount`                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | refunded_amount is the total sum of credit notes of type "refund".<br/>These are actual refunds issued to the customer.                                                                                                           |
+| `sourceType`                                                                                                                                                                                                                      | [models.InvoiceSourceType](../../sdk/models/invoice-source-type.md)                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `status`                                                                                                                                                                                                                          | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `subscription`                                                                                                                                                                                                                    | [models.SubscriptionResponse](../../sdk/models/subscription-response.md)                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `subscriptionCustomerId`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | subscription_customer_id is the subscription owner's customer ID (Subscription.CustomerID).<br/>It may differ from customer_id when the subscription uses an invoicing customer. Set internally; nullable in DB.                  |
 | `subscriptionId`                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | subscription_id is the ID of the subscription this invoice is associated with (only present for subscription-based invoices)                                                                                                      |
 | `subtotal`                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | subtotal is the sum of all line items before any taxes, discounts, or additional fees                                                                                                                                             |
+| `taxExemptionReasonCode`                                                                                                                                                                                                          | [models.TaxExemptionReasonCode](../../sdk/models/tax-exemption-reason-code.md)                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
+| `taxSummary`                                                                                                                                                                                                                      | [models.TaxSummary](../../sdk/models/tax-summary.md)                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `taxes`                                                                                                                                                                                                                           | [models.TaxAppliedResponse](../../sdk/models/tax-applied-response.md)[]                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                | tax_applied_records contains the tax applied records associated with this invoice                                                                                                                                                 |
 | `tenantId`                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `total`                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | total is the final amount including taxes, fees, and discounts                                                                                                                                                                    |

package/docs/sdk/models/invoice-source-type.md

@@ -0,0 +1,15 @@
+# InvoiceSourceType
+
+## Example Usage
+
+```typescript
+import { InvoiceSourceType } from "@flexprice/sdk/sdk/models";
+
+let value: InvoiceSourceType = "checkout";
+```
+
+## Values
+
+```typescript
+"checkout"
+```

package/docs/sdk/models/invoice-sync-settings.md

@@ -10,9 +10,12 @@ let value: InvoiceSyncSettings = {};
 
 ## Fields
 
-| Field                                                                                                                                                                                                                                                                                           | Type                                                                                                                                                                                                                                                                                            | Required                                                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                                                     |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `metadataCustomFields`                                                                                                                                                                                                                                                                          | [models.MetadataCustomField](../../sdk/models/metadata-custom-field.md)[]                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                              | MetadataCustomFields copies metadata values onto Zoho invoice custom fields<br/>verbatim.                                                                                                                                                                                                       |
-| `normalizeFixedTo`                                                                                                                                                                                                                                                                              | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                                                                             |
-| `servicePeriodCustomFields`                                                                                                                                                                                                                                                                     | [models.ServicePeriodCustomFields](../../sdk/models/service-period-custom-fields.md)                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                              | N/A                                                                                                                                                                                                                                                                                             |
-| `submitForApproval`                                                                                                                                                                                                                                                                             | *boolean*                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                              | SubmitForApproval submits the synced invoice into the merchant's Zoho Books approval<br/>flow before recording payment. Zoho rejects payments on draft invoices, and merchants<br/>configure a Zoho auto-approval rule for FlexPrice-sent invoices, so we submit, wait for<br/>that rule to fire, then pay. |
+| Field                                                                                                                                                                       | Type                                                                                                                                                                        | Required                                                                                                                                                                    | Description                                                                                                                                                                 |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `depositToAccountId`                                                                                                                                                        | *string*                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                          | Zoho chart-of-accounts id ("Deposit To"). Empty omits account_id, leaving Zoho's<br/>Undeposited Funds default.a                                                            |
+| `globalCustomFields`                                                                                                                                                        | [models.GlobalCustomField](../../sdk/models/global-custom-field.md)[]                                                                                                       | :heavy_minus_sign:                                                                                                                                                          | Fixed values written to Zoho invoice custom fields on every sync, independent of<br/>any metadata source.                                                                   |
+| `metadataCustomFields`                                                                                                                                                      | [models.MetadataCustomField](../../sdk/models/metadata-custom-field.md)[]                                                                                                   | :heavy_minus_sign:                                                                                                                                                          | Copies metadata values onto Zoho invoice custom fields verbatim.                                                                                                            |
+| `normalizeFixedTo`                                                                                                                                                          | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                  | :heavy_minus_sign:                                                                                                                                                          | N/A                                                                                                                                                                         |
+| `paymentMode`                                                                                                                                                               | *string*                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                          | Zoho payment modes are merchant-editable free strings with no id, so this is passed<br/>through verbatim. Empty means DefaultZohoPaymentMode.                               |
+| `servicePeriodCustomFields`                                                                                                                                                 | [models.ServicePeriodCustomFields](../../sdk/models/service-period-custom-fields.md)                                                                                        | :heavy_minus_sign:                                                                                                                                                          | N/A                                                                                                                                                                         |
+| `submitForApproval`                                                                                                                                                         | *boolean*                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                          | Zoho rejects payments on draft invoices, and merchants configure a Zoho auto-approval<br/>rule for FlexPrice-sent invoices, so we submit, wait for that rule to fire, then pay. |

package/docs/sdk/models/line-item-change.md

@@ -0,0 +1,20 @@
+# LineItemChange
+
+## Example Usage
+
+```typescript
+import { LineItemChange } from "@flexprice/sdk/sdk/models";
+
+let value: LineItemChange = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | Amount reprices the charge. Flat fee only for now.                                            |
+| `effectiveDate`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `quantity`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/line-item-grouping.md

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

package/docs/sdk/models/list-addon-associations-response.md

@@ -0,0 +1,146 @@
+# ListAddonAssociationsResponse
+
+## Example Usage
+
+```typescript
+import { ListAddonAssociationsResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ListAddonAssociationsResponse = {
+  items: [
+    {
+      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: {},
+          },
+        ],
+      },
+      subscription: {
+        couponAssociations: [
+          {
+            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: {},
+              },
+            },
+          },
+        ],
+        entitlements: [
+          {
+            feature: {
+              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"),
+              },
+            },
+          },
+        ],
+        latestInvoice: {
+          subscription: {
+            couponAssociations: [
+              {
+                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: {},
+                  },
+                },
+              },
+            ],
+            entitlements: [
+              {
+                feature: {
+                  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: {},
+          },
+        },
+        plan: {},
+      },
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `items`                                                                             | [models.AddonAssociationResponse](../../sdk/models/addon-association-response.md)[] | :heavy_minus_sign:                                                                  | N/A                                                                                 |
+| `pagination`                                                                        | [models.PaginationResponse](../../sdk/models/pagination-response.md)                | :heavy_minus_sign:                                                                  | N/A                                                                                 |

package/docs/sdk/models/list-refunds-request.md

@@ -0,0 +1,23 @@
+# ListRefundsRequest
+
+## Example Usage
+
+```typescript
+import { ListRefundsRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ListRefundsRequest = {};
+```
+
+## Fields
+
+| Field                          | Type                           | Required                       | Description                    |
+| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
+| `invoiceIds`                   | *string*[]                     | :heavy_minus_sign:             | Filter by invoice IDs          |
+| `paymentIds`                   | *string*[]                     | :heavy_minus_sign:             | Filter by payment IDs          |
+| `creditNoteIds`                | *string*[]                     | :heavy_minus_sign:             | Filter by credit note IDs      |
+| `refundStatuses`               | *string*[]                     | :heavy_minus_sign:             | Filter by refund status        |
+| `refundDestinations`           | *string*[]                     | :heavy_minus_sign:             | Filter by refund destination   |
+| `gateway`                      | *string*                       | :heavy_minus_sign:             | Filter by payment gateway      |
+| `onlySettled`                  | *boolean*                      | :heavy_minus_sign:             | Only refunds that have settled |
+| `limit`                        | *number*                       | :heavy_minus_sign:             | Limit                          |
+| `offset`                       | *number*                       | :heavy_minus_sign:             | Offset                         |

package/docs/sdk/models/list-refunds-response.md

@@ -0,0 +1,16 @@
+# ListRefundsResponse
+
+## Example Usage
+
+```typescript
+import { ListRefundsResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ListRefundsResponse = {};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `items`                                                              | [models.RefundResponse](../../sdk/models/refund-response.md)[]       | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `pagination`                                                         | [models.PaginationResponse](../../sdk/models/pagination-response.md) | :heavy_minus_sign:                                                   | N/A                                                                  |

package/docs/sdk/models/list-subscription-schedules-request.md

@@ -6,7 +6,7 @@
 import { ListSubscriptionSchedulesRequest } from "@flexprice/sdk/sdk/models";
 
 let value: ListSubscriptionSchedulesRequest = {
-  subscriptionId: "<id>",
+  id: "<id>",
 };
 ```
 
@@ -14,4 +14,4 @@ let value: ListSubscriptionSchedulesRequest = {
 
 | Field              | Type               | Required           | Description        |
 | ------------------ | ------------------ | ------------------ | ------------------ |
-| `subscriptionId`   | *string*           | :heavy_check_mark: | Subscription ID    |
+| `id`               | *string*           | :heavy_check_mark: | Subscription ID    |

package/docs/sdk/models/meter-aggregation.md

@@ -10,11 +10,11 @@ let value: MeterAggregation = {};
 
 ## Fields
 
-| Field                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                               |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `bucketSize`                                                                                                                                                                                                                                                                                              | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                       |
-| `expression`                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | Expression is an optional CEL expression to compute per-event quantity from event.properties.<br/>When set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).                                                                                        |
-| `field`                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | Field is the key in $event.properties on which the aggregation is to be applied<br/>For ex if the aggregation type is sum for API usage, the field could be "duration_ms"<br/>Ignored when Expression is set.                                                                                             |
-| `groupBy`                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | GroupBy is the property name in event.properties to group by before aggregating.<br/>Currently only supported for MAX aggregation with bucket_size.<br/>When set, aggregation is applied per unique value of this property within each bucket,<br/>then the per-group results are summed to produce the bucket total. |
-| `multiplier`                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | Multiplier is the multiplier for the aggregation<br/>For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000<br/>to scale up by a factor of 1000. If not provided, it will be null.                                                                             |
-| `type`                                                                                                                                                                                                                                                                                                    | [models.AggregationType](../../sdk/models/aggregation-type.md)                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                       |
+| Field                                                                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                               |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bucketSize`                                                                                                                                                                                                                                                                                                                                              | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                       |
+| `expression`                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Expression is an optional CEL expression to compute per-event quantity from event.properties.<br/>When set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).                                                                                                                                        |
+| `field`                                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Field is the key in $event.properties on which the aggregation is to be applied<br/>For ex if the aggregation type is sum for API usage, the field could be "duration_ms"<br/>Ignored when Expression is set.                                                                                                                                             |
+| `groupBy`                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | GroupBy is the property name in event.properties to group by before aggregating.<br/>Requires MAX aggregation. Windowing comes from the price, so this no longer<br/>implies a meter-level bucket_size.<br/>When set, aggregation is applied per unique value of this property within each bucket,<br/>then the per-group results are summed to produce the bucket total. |
+| `multiplier`                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | Multiplier is the multiplier for the aggregation<br/>For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000<br/>to scale up by a factor of 1000. If not provided, it will be null.                                                                                                                             |
+| `type`                                                                                                                                                                                                                                                                                                                                                    | [models.AggregationType](../../sdk/models/aggregation-type.md)                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                       |

package/docs/sdk/models/metric.md

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

package/docs/sdk/models/modify-subscription-line-item.md

@@ -12,6 +12,7 @@ let value: ModifySubscriptionLineItem = {};
 
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `effectiveDate`                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `lineItemId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `quantity`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/modify-subscription-params.md

@@ -13,4 +13,5 @@ let value: ModifySubscriptionParams = {};
 | Field                                                                                    | Type                                                                                     | Required                                                                                 | Description                                                                              |
 | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
 | `lineItemModifications`                                                                  | [models.ModifySubscriptionLineItem](../../sdk/models/modify-subscription-line-item.md)[] | :heavy_minus_sign:                                                                       | N/A                                                                                      |
+| `modifyType`                                                                             | [models.ModifySubscriptionType](../../sdk/models/modify-subscription-type.md)            | :heavy_minus_sign:                                                                       | N/A                                                                                      |
 | `subscriptionId`                                                                         | *string*                                                                                 | :heavy_minus_sign:                                                                       | N/A                                                                                      |