@flexprice/sdk 2.1.33 → 2.1.35

package/README.md

@@ -126,9 +126,41 @@ const result = await flexPrice.events.ingestEvent({
 
 ## Authentication
 
-- Set the API key via `apiKeyAuth` when constructing `FlexPrice`. The SDK sends it in the `x-api-key` header.
-- Set `FLEXPRICE_API_HOST` to a full URL (see [Environment](#environment)) or rely on the default `https://us.api.flexprice.io/v1`.
-- Use environment variables and never expose keys in client-side or public code. Get keys from your [FlexPrice dashboard](https://app.flexprice.io) or docs.
+The SDK supports two credentials. Set one of them, not both.
+
+| Option | Header | Use it for |
+| ------ | ------ | ---------- |
+| `apiKeyAuth` | `x-api-key` | Servers and scripts |
+| `bearerAuth` | `Authorization: Bearer <token>` | A browser app acting as a signed-in FlexPrice user |
+
+**API key (server side).** Set the key via `apiKeyAuth`. Keys created in the dashboard are bound to one environment, so no other option is needed.
+
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({ apiKeyAuth: process.env.FLEXPRICE_API_KEY! });
+```
+
+**Signed-in user (browser).** Pass the user's JWT via `bearerAuth`, and the active environment via `environmentId`, which is sent as `X-Environment-ID`. Most endpoints are scoped to an environment and return 403 without it.
+
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  serverURL: "https://us.api.flexprice.io/v1",
+  bearerAuth: async () => getAccessToken(),
+  environmentId: () => getActiveEnvironmentId(),
+});
+```
+
+- Both options take a string or a function, so a refreshed token or a switched environment applies without creating a new client. The SDK does not refresh tokens itself.
+- A `bearerAuth` function is called before every attempt, retries included. An `environmentId` function is called once per API call, so a retry never switches environments.
+- If the value or the function result is empty, that header is not sent.
+- Headers passed on a single call (`{ headers: { ... } }`) take precedence over these options, and the matching option's function is not called.
+- `environmentId` also works with `apiKeyAuth`. The API ignores it for keys bound to an environment.
+- Setting both `apiKeyAuth` and `bearerAuth` fails every call with an `UnexpectedClientError` before anything is sent.
+
+Set `FLEXPRICE_API_HOST` to a full URL (see [Environment](#environment)) or rely on the default `https://us.api.flexprice.io/v1`.
 
 ## Features
 
@@ -142,6 +174,10 @@ For a full list of operations, see the [API reference](https://docs.flexprice.io
 ## Troubleshooting
 
 - **Missing or invalid API key:** Ensure `apiKeyAuth` is set and the key is active. Use server-side only.
+- **401 with `bearerAuth`:** The token is missing or expired. Check that your token function returns a current JWT.
+- **403 with `bearerAuth`:** Set `environmentId`. Dashboard login tokens are not bound to an environment.
+- **"set either apiKeyAuth or bearerAuth, not both":** Remove one of the two options from the constructor.
+- **`debugLogger`:** It prints every request header, including `Authorization` and `x-api-key`. Use it only for local debugging.
 - **Wrong server URL:** Use a full URL such as `https://us.api.flexprice.io/v1` (include `/v1`; no trailing slash).
 - **Validation or 4xx errors:** Confirm request body field names (snake_case vs camelCase) and required fields against the [API docs](https://docs.flexprice.io).
 - **Parameter passing:** Pass the request object directly to methods (e.g. `ingestEvent({ ... })`), not wrapped in an extra key, unless the SDK docs say otherwise.

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

@@ -6,7 +6,7 @@
 import { CheckoutParams } from "@flexprice/sdk/sdk/models";
 
 let value: CheckoutParams = {
-  paymentProvider: "razorpay",
+  paymentProvider: "chargebee",
 };
 ```
 

package/docs/sdk/models/checkout-payment-provider.md

@@ -13,5 +13,5 @@ let value: CheckoutPaymentProvider = "razorpay";
 ## Values
 
 ```typescript
-"razorpay" | "chargebee" | Unrecognized<string>
+"razorpay" | "chargebee" | "stripe" | Unrecognized<string>
 ```

package/docs/sdk/models/configuration-details.md

@@ -0,0 +1,15 @@
+# ConfigurationDetails
+
+## Example Usage
+
+```typescript
+import { ConfigurationDetails } from "@flexprice/sdk/sdk/models";
+
+let value: ConfigurationDetails = {};
+```
+
+## Fields
+
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `planChange`                                                                         | [models.PlanChangeScheduleDetails](../../sdk/models/plan-change-schedule-details.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |

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

@@ -17,7 +17,7 @@ let value: CostAnalyticItem = {};
 | `currency`                                           | *string*                                             | :heavy_minus_sign:                                   | Metadata                                             |
 | `customerId`                                         | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
 | `externalCustomerId`                                 | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
-| `meter`                                              | [models.MeterMeter](../../sdk/models/meter-meter.md) | :heavy_minus_sign:                                   | N/A                                                  |
+| `meter`                                              | [models.Meter](../../sdk/models/meter.md)            | :heavy_minus_sign:                                   | N/A                                                  |
 | `meterId`                                            | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
 | `meterName`                                          | *string*                                             | :heavy_minus_sign:                                   | N/A                                                  |
 | `price`                                              | [models.PricePrice](../../sdk/models/price-price.md) | :heavy_minus_sign:                                   | N/A                                                  |

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

@@ -23,6 +23,7 @@ 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                                                                                                                              |
+| `billingCurrency`                                                                                                                                                                                             | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | billing_currency is the fiat currency invoices are issued in; empty means the charge currency is used as-is                                                                                                   |
 | `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)                                                                                                                   |

package/docs/sdk/models/create-fx-rate-request.md

@@ -0,0 +1,27 @@
+# CreateFXRateRequest
+
+## Example Usage
+
+```typescript
+import { CreateFXRateRequest } from "@flexprice/sdk/sdk/models";
+
+let value: CreateFXRateRequest = {
+  fromCurrency: "<value>",
+  scope: "tenant",
+  toCurrency: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FXRateSource](../../sdk/models/fx-rate-source.md)                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |

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

@@ -33,6 +33,7 @@ let value: CreateSubscriptionRequest = {
 | `enableTrueUp`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `externalCustomerId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `fxRates`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | [models.InlineFXRate](../../sdk/models/inline-fx-rate.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | FxRates sets subscription-scope rates to the invoicing customer's billing currency, one per<br/>non-overlapping window. Rejected when nothing needs converting or the pair has no tenant rate.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | `gatewayPaymentMethodId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | `includePriceIds`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | *string*[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | IncludePriceIDs selects which plan prices to attach. Nil/omitted attaches matching-cadence<br/>prices plus ONETIME; [] attaches none (LineItems extras still apply); a non-empty list<br/>attaches only those IDs. Each listed ID must belong to the plan, match the subscription<br/>currency, and have a cadence that equals or strictly divides the subscription cadence.<br/>Pointer-slice distinguishes nil from [].<br/>NOTE: no `dive,required` on this tag — swaggo misinterprets `required`<br/>inside `dive` as marking the whole field required, which then shows up<br/>in the OpenAPI schema and breaks callers that omit the field. Per-element<br/>non-emptiness is enforced explicitly in Validate() below. |
 | `inheritance`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [models.SubscriptionInheritanceConfig](../../sdk/models/subscription-inheritance-config.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

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

@@ -20,6 +20,7 @@ let value: CustomerResponse = {};
 | `addressLine2`                                                                                                                       | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | AddressLine2 is the second line of the customer's address                                                                            |
 | `addressPostalCode`                                                                                                                  | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | AddressPostalCode is the postal code of the customer's address                                                                       |
 | `addressState`                                                                                                                       | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | AddressState is the state of the customer's address                                                                                  |
+| `billingCurrency`                                                                                                                    | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | BillingCurrency is the fiat currency invoices are issued in; nil means charge currency is used as-is.                                |
 | `contact`                                                                                                                            | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | Contact is an optional contact number for the customer (e.g. phone)                                                                  |
 | `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                                                                                                                                  |

package/docs/sdk/models/customer.md

@@ -18,6 +18,7 @@ let value: Customer = {};
 | `addressLine2`                                                                                                                       | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | AddressLine2 is the second line of the customer's address                                                                            |
 | `addressPostalCode`                                                                                                                  | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | AddressPostalCode is the postal code of the customer's address                                                                       |
 | `addressState`                                                                                                                       | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | AddressState is the state of the customer's address                                                                                  |
+| `billingCurrency`                                                                                                                    | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | BillingCurrency is the fiat currency invoices are issued in; nil means charge currency is used as-is.                                |
 | `contact`                                                                                                                            | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | Contact is an optional contact number for the customer (e.g. phone)                                                                  |
 | `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                                                                                                                                  |

package/docs/sdk/models/delete-fx-rate-request.md

@@ -0,0 +1,17 @@
+# DeleteFXRateRequest
+
+## Example Usage
+
+```typescript
+import { DeleteFXRateRequest } from "@flexprice/sdk/sdk/models";
+
+let value: DeleteFXRateRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | FX rate ID         |

package/docs/sdk/models/execution-details.md

@@ -0,0 +1,15 @@
+# ExecutionDetails
+
+## Example Usage
+
+```typescript
+import { ExecutionDetails } from "@flexprice/sdk/sdk/models";
+
+let value: ExecutionDetails = {};
+```
+
+## Fields
+
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `planChange`                                                                       | [models.PlanChangeScheduleResult](../../sdk/models/plan-change-schedule-result.md) | :heavy_minus_sign:                                                                 | N/A                                                                                |

package/docs/sdk/models/fx-conversion-source.md

@@ -0,0 +1,18 @@
+# FxConversionSource
+
+## Example Usage
+
+```typescript
+import { FxConversionSource } from "@flexprice/sdk/sdk/models";
+
+let value: FxConversionSource = {};
+```
+
+## Fields
+
+| Field                        | Type                         | Required                     | Description                  |
+| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
+| `net`                        | *string*                     | :heavy_minus_sign:           | N/A                          |
+| `subtotal`                   | *string*                     | :heavy_minus_sign:           | N/A                          |
+| `totalDiscount`              | *string*                     | :heavy_minus_sign:           | N/A                          |
+| `totalPrepaidCreditsApplied` | *string*                     | :heavy_minus_sign:           | N/A                          |

package/docs/sdk/models/fx-conversion.md

@@ -0,0 +1,21 @@
+# FxConversion
+
+## Example Usage
+
+```typescript
+import { FxConversion } from "@flexprice/sdk/sdk/models";
+
+let value: FxConversion = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `billingCurrency`                                                                             | *string*                                                                                      | :heavy_minus_sign:                                                                            | BillingCurrency is the currency the invoice was issued in.                                    |
+| `chargeCurrency`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | ChargeCurrency is the invoice's original (draft) currency.                                    |
+| `convertedAt`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | ConvertedAt is when the conversion ran.                                                       |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | Rate is the frozen rate: billing per 1 charge unit.                                           |
+| `rateId`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | RateID is the fx_rates row used, for reference only; never read again.                        |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FxConversionSource](../../sdk/models/fx-conversion-source.md)                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/fx-rate-filter-order.md

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

package/docs/sdk/models/fx-rate-filter.md

@@ -0,0 +1,28 @@
+# FXRateFilter
+
+## Example Usage
+
+```typescript
+import { FXRateFilter } from "@flexprice/sdk/sdk/models";
+
+let value: FXRateFilter = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endTime`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `expand`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `filters`                                                                                     | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                              | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fxRateIds`                                                                                   | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `limit`                                                                                       | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `offset`                                                                                      | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `order`                                                                                       | [models.FXRateFilterOrder](../../sdk/models/fx-rate-filter-order.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `sort`                                                                                        | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startTime`                                                                                   | [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                                                                                           |
+| `toCurrency`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/fx-rate-response.md

@@ -0,0 +1,31 @@
+# FXRateResponse
+
+## Example Usage
+
+```typescript
+import { FXRateResponse } from "@flexprice/sdk/sdk/models";
+
+let value: FXRateResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `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                                                                                           |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `fromCurrency`                                                                                | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scope`                                                                                       | [models.FXRateScope](../../sdk/models/fx-rate-scope.md)                                       | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `scopeId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `source`                                                                                      | [models.FXRateSource](../../sdk/models/fx-rate-source.md)                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `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                                                                                           |
+| `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `toCurrency`                                                                                  | *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/fx-rate-scope.md

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

package/docs/sdk/models/fx-rate-source.md

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

package/docs/sdk/models/get-event-request.md

@@ -7,11 +7,15 @@ import { GetEventRequest } from "@flexprice/sdk/sdk/models";
 
 let value: GetEventRequest = {
   id: "<id>",
+  externalCustomerId: "<id>",
 };
 ```
 
 ## Fields
 
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `id`               | *string*           | :heavy_check_mark: | Event ID           |
+| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `id`                                                                               | *string*                                                                           | :heavy_check_mark:                                                                 | Event ID                                                                           |
+| `externalCustomerId`                                                               | *string*                                                                           | :heavy_check_mark:                                                                 | External customer ID the event was ingested with                                   |
+| `startTime`                                                                        | *string*                                                                           | :heavy_minus_sign:                                                                 | Start of the event timestamp window (RFC3339); defaults to 14 days before end_time |
+| `endTime`                                                                          | *string*                                                                           | :heavy_minus_sign:                                                                 | End of the event timestamp window (RFC3339); defaults to now                       |

package/docs/sdk/models/get-fx-rate-request.md

@@ -0,0 +1,17 @@
+# GetFXRateRequest
+
+## Example Usage
+
+```typescript
+import { GetFXRateRequest } from "@flexprice/sdk/sdk/models";
+
+let value: GetFXRateRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | FX rate ID         |

package/docs/sdk/models/inline-fx-rate.md

@@ -0,0 +1,17 @@
+# InlineFXRate
+
+## Example Usage
+
+```typescript
+import { InlineFXRate } from "@flexprice/sdk/sdk/models";
+
+let value: InlineFXRate = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `rate`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

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

@@ -24,6 +24,7 @@ let value: InvoiceLineItemResponse = {};
 | `entityId`                                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
 | `entityType`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
 | `environmentId`                                                                                                                                                                                               | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
+| `fxConversion`                                                                                                                                                                                                | [models.FxConversion](../../sdk/models/fx-conversion.md)                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
 | `id`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
 | `invoiceId`                                                                                                                                                                                                   | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | N/A                                                                                                                                                                                                           |
 | `invoiceLevelDiscount`                                                                                                                                                                                        | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | invoice_level_discount is the discount amount in invoice currency applied to all line items on the invoice.                                                                                                   |

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

@@ -140,6 +140,7 @@ let value: InvoiceResponse = {
 | `dueDate`                                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                | due_date is the date when payment for this invoice is due                                                                                                                                                                         |
 | `environmentId`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | environment_id is the ID of the environment this invoice belongs to (for multi-environment setups)                                                                                                                                |
 | `finalizedAt`                                                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                | finalized_at is the timestamp when this invoice was finalized and made ready for payment                                                                                                                                          |
+| `fxConversion`                                                                                                                                                                                                                    | [models.FxConversion](../../sdk/models/fx-conversion.md)                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                               |
 | `id`                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | id is the unique identifier for this invoice                                                                                                                                                                                      |
 | `idempotencyKey`                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | idempotency_key is a unique key used to prevent duplicate invoice creation when retrying API calls                                                                                                                                |
 | `invoiceNumber`                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                | invoice_number is the human-readable invoice number displayed to customers (e.g., INV-2024-001)                                                                                                                                   |

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

@@ -10,9 +10,12 @@ let value: ListAllSubscriptionSchedulesRequest = {};
 
 ## Fields
 
-| Field                            | Type                             | Required                         | Description                      |
-| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
-| `pendingOnly`                    | *boolean*                        | :heavy_minus_sign:               | Filter to pending schedules only |
-| `subscriptionId`                 | *string*                         | :heavy_minus_sign:               | Filter by subscription ID        |
-| `limit`                          | *number*                         | :heavy_minus_sign:               | Limit results                    |
-| `offset`                         | *number*                         | :heavy_minus_sign:               | Offset for pagination            |
+| Field                                                                                                                      | Type                                                                                                                       | Required                                                                                                                   | Description                                                                                                                |
+| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `pendingOnly`                                                                                                              | *boolean*                                                                                                                  | :heavy_minus_sign:                                                                                                         | Filter to pending schedules only                                                                                           |
+| `subscriptionId`                                                                                                           | *string*                                                                                                                   | :heavy_minus_sign:                                                                                                         | Filter by subscription ID                                                                                                  |
+| `subscriptionIds`                                                                                                          | *string*[]                                                                                                                 | :heavy_minus_sign:                                                                                                         | Filter by subscription IDs                                                                                                 |
+| `scheduleType`                                                                                                             | [models.ListAllSubscriptionSchedulesScheduleType](../../sdk/models/list-all-subscription-schedules-schedule-type.md)[]     | :heavy_minus_sign:                                                                                                         | Filter by schedule type                                                                                                    |
+| `scheduleStatus`                                                                                                           | [models.ListAllSubscriptionSchedulesScheduleStatus](../../sdk/models/list-all-subscription-schedules-schedule-status.md)[] | :heavy_minus_sign:                                                                                                         | Filter by schedule status                                                                                                  |
+| `limit`                                                                                                                    | *number*                                                                                                                   | :heavy_minus_sign:                                                                                                         | Limit results                                                                                                              |
+| `offset`                                                                                                                   | *number*                                                                                                                   | :heavy_minus_sign:                                                                                                         | Offset for pagination                                                                                                      |