@flexprice/sdk 2.1.34 → 2.1.36

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/add-addon-ref.md

@@ -15,5 +15,6 @@ let value: AddAddonRef = {};
 | `addonId`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `associationId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `cadence`                                                                                     | [models.AddonCadence](../../sdk/models/addon-cadence.md)                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `coupons`                                                                                     | [models.CouponRef](../../sdk/models/coupon-ref.md)[]                                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `prorationBehavior`                                                                           | [models.ProrationBehavior](../../sdk/models/proration-behavior.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                                                                                           |

package/docs/sdk/models/add-addon-request.md

@@ -19,6 +19,7 @@ let value: AddAddonRequest = {
 | `cadence`                                                                                           | [models.AddonCadence](../../sdk/models/addon-cadence.md)                                            | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
 | `changeAt`                                                                                          | [models.ScheduleType](../../sdk/models/schedule-type.md)                                            | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
 | `checkout`                                                                                          | [models.CheckoutParams](../../sdk/models/checkout-params.md)                                        | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
+| `coupons`                                                                                           | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]                   | :heavy_minus_sign:                                                                                  | Coupons apply to this addon's line items; price_id targets one price, omitted targets all.          |
 | `lineItemCommitments`                                                                               | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)>  | :heavy_minus_sign:                                                                                  | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
 | `metadata`                                                                                          | Record<string, *any*>                                                                               | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
 | `overrideLineItems`                                                                                 | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                  | :heavy_minus_sign:                                                                                  | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices          |

package/docs/sdk/models/add-addon-to-subscription-request.md

@@ -17,6 +17,7 @@ let value: AddAddonToSubscriptionRequest = {
 | `addonId`                                                                                           | *string*                                                                                            | :heavy_check_mark:                                                                                  | N/A                                                                                                 |
 | `cadence`                                                                                           | [models.AddonCadence](../../sdk/models/addon-cadence.md)                                            | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
 | `changeAt`                                                                                          | [models.ScheduleType](../../sdk/models/schedule-type.md)                                            | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
+| `coupons`                                                                                           | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]                   | :heavy_minus_sign:                                                                                  | Coupons apply to this addon's line items; price_id targets one price, omitted targets all.          |
 | `lineItemCommitments`                                                                               | Record<string, [models.LineItemCommitmentConfig](../../sdk/models/line-item-commitment-config.md)>  | :heavy_minus_sign:                                                                                  | LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id) |
 | `metadata`                                                                                          | Record<string, *any*>                                                                               | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
 | `overrideLineItems`                                                                                 | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                  | :heavy_minus_sign:                                                                                  | OverrideLineItems allows overriding price/quantity/billing model for specific addon prices          |

package/docs/sdk/models/coupon-ref.md

@@ -0,0 +1,19 @@
+# CouponRef
+
+## Example Usage
+
+```typescript
+import { CouponRef } from "@flexprice/sdk/sdk/models";
+
+let value: CouponRef = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `associationId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `couponId`                                                                                    | *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                                                                                           |
+| `priceId`                                                                                     | *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/create-credit-grant-request.md

@@ -31,6 +31,7 @@ let value: CreateCreditGrantRequest = {
 | `periodCount`                                                                                                                                                                                                                                            | *number*                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `planId`                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `priority`                                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
+| `prorationBehavior`                                                                                                                                                                                                                                      | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `scope`                                                                                                                                                                                                                                                  | [models.CreditGrantScope](../../sdk/models/credit-grant-scope.md)                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `startDate`                                                                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |
 | `subscriptionId`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                      |

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

@@ -8,6 +8,11 @@ Request object for creating a new customer in the system
 import { CreateCustomerRequest } from "@flexprice/sdk/sdk/models";
 
 let value: CreateCustomerRequest = {
+  contactPersons: [
+    {
+      firstName: "Ryan",
+    },
+  ],
   externalId: "<id>",
   name: "<value>",
 };
@@ -23,7 +28,9 @@ 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)                                                                                                                                           |
+| `contactPersons`                                                                                                                                                                                              | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[]                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                            | contact_persons are people at the customer; at most one may be primary                                                                                                                                        |
 | `email`                                                                                                                                                                                                       | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | email is the customer's email address and must be a valid email format if provided                                                                                                                            |
 | `externalId`                                                                                                                                                                                                  | *string*                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                            | external_id is the unique identifier from your system to reference this customer (required)                                                                                                                   |
 | `integrationEntityMapping`                                                                                                                                                                                    | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[]                                                                                               | :heavy_minus_sign:                                                                                                                                                                                            | integration_entity_mapping contains provider integration mappings for this customer                                                                                                                           |

package/docs/sdk/models/create-scheduled-task-request.md

@@ -7,7 +7,7 @@ import { CreateScheduledTaskRequest } from "@flexprice/sdk/sdk/models";
 
 let value: CreateScheduledTaskRequest = {
   connectionId: "<id>",
-  entityType: "credit_usage",
+  entityType: "wallet_debits",
   interval: "30MIN",
   jobConfig: {},
 };

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-contact-person.md

@@ -0,0 +1,25 @@
+# CustomerContactPerson
+
+## Example Usage
+
+```typescript
+import { CustomerContactPerson } from "@flexprice/sdk/sdk/models";
+
+let value: CustomerContactPerson = {
+  firstName: "Burley",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `department`       | *string*           | :heavy_minus_sign: | N/A                |
+| `designation`      | *string*           | :heavy_minus_sign: | N/A                |
+| `email`            | *string*           | :heavy_minus_sign: | N/A                |
+| `firstName`        | *string*           | :heavy_check_mark: | N/A                |
+| `id`               | *string*           | :heavy_minus_sign: | N/A                |
+| `isPrimary`        | *boolean*          | :heavy_minus_sign: | N/A                |
+| `lastName`         | *string*           | :heavy_minus_sign: | N/A                |
+| `mobile`           | *string*           | :heavy_minus_sign: | N/A                |
+| `salutation`       | *string*           | :heavy_minus_sign: | N/A                |

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

@@ -20,7 +20,9 @@ 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)                                                                  |
+| `contactPersons`                                                                                                                     | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[]                                                        | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
 | `createdAt`                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                        | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
 | `createdBy`                                                                                                                          | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
 | `email`                                                                                                                              | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | Email is the email of the customer                                                                                                   |

package/docs/sdk/models/customer.md

@@ -18,7 +18,9 @@ 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)                                                                  |
+| `contactPersons`                                                                                                                     | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[]                                                        | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
 | `createdAt`                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                        | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
 | `createdBy`                                                                                                                          | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | N/A                                                                                                                                  |
 | `email`                                                                                                                              | *string*                                                                                                                             | :heavy_minus_sign:                                                                                                                   | Email is the email of the customer                                                                                                   |

package/docs/sdk/models/external-tax-details.md

@@ -0,0 +1,25 @@
+# ExternalTaxDetails
+
+## Example Usage
+
+```typescript
+import { ExternalTaxDetails } from "@flexprice/sdk/sdk/models";
+
+let value: ExternalTaxDetails = {};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                           |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `calculationExpiresAt`                                                                                                                                                                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                    | CalculationExpiresAt is when the calculation can no longer be filed, RFC3339.                                                                                                                                                                         |
+| `calculationId`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | CalculationID is the provider calculation this row was written from. Commit files it.                                                                                                                                                                 |
+| `displayName`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | DisplayName is the engine's own name for the tax, such as<br/>"Integrated goods and services tax (IGST)".                                                                                                                                             |
+| `jurisdiction`                                                                                                                                                                                                                                        | [models.TaxJurisdiction](../../sdk/models/tax-jurisdiction.md)                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                   |
+| `percentage`                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | Percentage is the resolved rate, such as "18.0". This is what was charged, not the<br/>rate that would apply if the tax were imposed.                                                                                                                 |
+| `reference`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | Reference is what this row's provider transaction was filed under. It is unique across<br/>every transaction on the account, so it is also the only way back to a transaction whose<br/>id failed to land here.                                       |
+| `reversal`                                                                                                                                                                                                                                            | [models.TaxReversal](../../sdk/models/tax-reversal.md)                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                    | N/A                                                                                                                                                                                                                                                   |
+| `sourcing`                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | Sourcing is whether the jurisdiction followed the seller's address or the buyer's.                                                                                                                                                                    |
+| `taxCode`                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | TaxCode is the product tax category the engine priced against, such as txcd_10000000.<br/>It belongs to the line rather than the rate, so today every row on an invoice carries<br/>the account default. It only varies once tax is calculated per line item. |
+| `taxType`                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | TaxType is the tax family, such as vat, igst or sales_tax.                                                                                                                                                                                            |
+| `taxabilityReason`                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                    | TaxabilityReason is why the engine charged what it did, such as standard_rated or<br/>reverse_charge. Recorded, not yet rendered.                                                                                                                     |

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/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/line-item-change.md

@@ -15,6 +15,7 @@ let value: LineItemChange = {
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
 | `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | Amount reprices the charge. Flat fee only for now.                                            |
+| `coupons`                                                                                     | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]             | :heavy_minus_sign:                                                                            | Coupons apply to the new line item created by this change.                                    |
 | `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/modify-subscription-line-item.md

@@ -13,6 +13,7 @@ let value: ModifySubscriptionLineItem = {};
 | Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
 | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
 | `amount`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `coupons`                                                                                     | [models.CouponRef](../../sdk/models/coupon-ref.md)[]                                          | :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/scheduled-task-entity-type.md

@@ -13,5 +13,5 @@ let value: ScheduledTaskEntityType = "invoice";
 ## Values
 
 ```typescript
-"events" | "invoice" | "credit_topups" | "credit_usage" | "usage_analytics" | "revenue_facts" | Unrecognized<string>
+"events" | "invoice" | "credit_topups" | "wallet_debits" | "credit_usage" | "usage_analytics" | "revenue_facts" | Unrecognized<string>
 ```

package/docs/sdk/models/tax-applied-response.md

@@ -19,15 +19,19 @@ let value: TaxAppliedResponse = {};
 | `entityId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `entityType`                                                                                  | [models.TaxRateEntityType](../../sdk/models/tax-rate-entity-type.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `externalTaxDetails`                                                                          | [models.ExternalTaxDetails](../../sdk/models/external-tax-details.md)                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `idempotencyKey`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `provider`                                                                                    | [models.TaxProvider](../../sdk/models/tax-provider.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxAmount`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxAssociationId`                                                                            | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxBehavior`                                                                                 | [models.TaxBehavior](../../sdk/models/tax-behavior.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxRate`                                                                                     | [models.TaxRateResponse](../../sdk/models/tax-rate-response.md)                               | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `taxRateId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `taxRateId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | Null when an external engine calculated the tax: there is no Flexprice rate to point at.      |
+| `taxTransactionId`                                                                            | *string*                                                                                      | :heavy_minus_sign:                                                                            | TaxTransactionID is the provider transaction recording the filed tax, stamped at commit.      |
+| `taxTransactionType`                                                                          | [models.TaxTransactionType](../../sdk/models/tax-transaction-type.md)                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `taxableAmount`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
 | `updatedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/tax-exemption-reason-code.md

@@ -5,7 +5,7 @@
 ```typescript
 import { TaxExemptionReasonCode } from "@flexprice/sdk/sdk/models";
 
-let value: TaxExemptionReasonCode = "no_tax_configured";
+let value: TaxExemptionReasonCode = "not_subject_to_tax";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: TaxExemptionReasonCode = "no_tax_configured";
 ## Values
 
 ```typescript
-"customer_exempt" | "no_tax_configured" | Unrecognized<string>
+"customer_exempt" | "no_tax_configured" | "reverse_charge" | "not_collecting" | "not_subject_to_tax" | "not_supported" | Unrecognized<string>
 ```

package/docs/sdk/models/tax-jurisdiction.md

@@ -0,0 +1,18 @@
+# TaxJurisdiction
+
+## Example Usage
+
+```typescript
+import { TaxJurisdiction } from "@flexprice/sdk/sdk/models";
+
+let value: TaxJurisdiction = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `country`          | *string*           | :heavy_minus_sign: | N/A                |
+| `displayName`      | *string*           | :heavy_minus_sign: | N/A                |
+| `level`            | *string*           | :heavy_minus_sign: | N/A                |
+| `state`            | *string*           | :heavy_minus_sign: | N/A                |

package/docs/sdk/models/tax-provider.md

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