@flexprice/sdk 2.0.10 → 2.0.11

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

@@ -5,7 +5,7 @@
 ```typescript
 import { CancellationType } from "@flexprice/sdk/sdk/models";
 
-let value: CancellationType = "immediate";
+let value: CancellationType = "end_of_period";
 
 // Open enum: unrecognized values are captured as Unrecognized<string>
 ```
@@ -13,5 +13,5 @@ let value: CancellationType = "immediate";
 ## Values
 
 ```typescript
-"immediate" | "end_of_period" | Unrecognized<string>
+"immediate" | "end_of_period" | "scheduled_date" | Unrecognized<string>
 ```

package/docs/sdk/models/dto-cancel-subscription-request.md

@@ -6,15 +6,16 @@
 import { DtoCancelSubscriptionRequest } from "@flexprice/sdk/sdk/models";
 
 let value: DtoCancelSubscriptionRequest = {
-  cancellationType: "immediate",
+  cancellationType: "end_of_period",
 };
 ```
 
 ## Fields
 
-| Field                                                                                          | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `cancelImmediatelyInovicePolicy`                                                               | [models.CancelImmediatelyInvoicePolicy](../../sdk/models/cancel-immediately-invoice-policy.md) | :heavy_minus_sign:                                                                             | N/A                                                                                            |
-| `cancellationType`                                                                             | [models.CancellationType](../../sdk/models/cancellation-type.md)                               | :heavy_check_mark:                                                                             | N/A                                                                                            |
-| `prorationBehavior`                                                                            | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                             | :heavy_minus_sign:                                                                             | N/A                                                                                            |
-| `reason`                                                                                       | *string*                                                                                       | :heavy_minus_sign:                                                                             | Reason for cancellation (for audit and business intelligence)                                  |
+| Field                                                                                                                              | Type                                                                                                                               | Required                                                                                                                           | Description                                                                                                                        |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `cancelAt`                                                                                                                         | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | CancelAt is the custom date to cancel the subscription.<br/>Required when CancellationType is "scheduled_date". Must be in the future. |
+| `cancelImmediatelyInovicePolicy`                                                                                                   | [models.CancelImmediatelyInvoicePolicy](../../sdk/models/cancel-immediately-invoice-policy.md)                                     | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |
+| `cancellationType`                                                                                                                 | [models.CancellationType](../../sdk/models/cancellation-type.md)                                                                   | :heavy_check_mark:                                                                                                                 | N/A                                                                                                                                |
+| `prorationBehavior`                                                                                                                | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                                                 | :heavy_minus_sign:                                                                                                                 | N/A                                                                                                                                |
+| `reason`                                                                                                                           | *string*                                                                                                                           | :heavy_minus_sign:                                                                                                                 | Reason for cancellation (for audit and business intelligence)                                                                      |

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

@@ -14,20 +14,20 @@ let value: DtoCreateCustomerRequest = {
 
 ## Fields
 
-| Field                                                                                                                                                                                                         | Type                                                                                                                                                                                                          | Required                                                                                                                                                                                                      | Description                                                                                                                                                                                                   |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `addressCity`                                                                                                                                                                                                 | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_city is the city name with maximum 100 characters                                                                                                                                                     |
-| `addressCountry`                                                                                                                                                                                              | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_country is the two-letter ISO 3166-1 alpha-2 country code                                                                                                                                             |
-| `addressLine1`                                                                                                                                                                                                | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | address_line1 is the primary address line with maximum 255 characters                                                                                                                                         |
-| `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                                                                                                                              |
-| `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.DtoIntegrationEntityMapping](../../sdk/models/dto-integration-entity-mapping.md)[]                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                            | integration_entity_mapping contains provider integration mappings for this customer                                                                                                                           |
-| `metadata`                                                                                                                                                                                                    | Record<string, *string*>                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | metadata contains additional key-value pairs for storing extra information                                                                                                                                    |
-| `name`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | name is the full name or company name of the customer                                                                                                                                                         |
-| `parentCustomerExternalId`                                                                                                                                                                                    | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | parent_customer_external_id is the external ID of the parent customer from your system<br/>Exactly one of parent_customer_id or parent_customer_external_id may be provided                                   |
-| `parentCustomerId`                                                                                                                                                                                            | *string*                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | parent_customer_id is the internal FlexPrice ID of the parent customer                                                                                                                                        |
-| `skipOnboardingWorkflow`                                                                                                                                                                                      | *boolean*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                            | skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered<br/>This is used internally when a customer is created via a workflow to prevent infinite loops<br/>Default: false |
-| `taxRateOverrides`                                                                                                                                                                                            | [models.DtoTaxRateOverride](../../sdk/models/dto-tax-rate-override.md)[]                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                            | tax_rate_overrides contains tax rate configurations to be linked to this customer                                                                                                                             |
+| Field                                                                                                                                                                                                                                                              | Type                                                                                                                                                                                                                                                               | Required                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `addressCity`                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | address_city is the city name with maximum 100 characters                                                                                                                                                                                                          |
+| `addressCountry`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | address_country is the two-letter ISO 3166-1 alpha-2 country code                                                                                                                                                                                                  |
+| `addressLine1`                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | address_line1 is the primary address line with maximum 255 characters                                                                                                                                                                                              |
+| `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                                                                                                                                                                                   |
+| `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.DtoIntegrationEntityMapping](../../sdk/models/dto-integration-entity-mapping.md)[]                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                 | integration_entity_mapping contains provider integration mappings for this customer                                                                                                                                                                                |
+| `metadata`                                                                                                                                                                                                                                                         | Record<string, *string*>                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | metadata contains additional key-value pairs for storing extra information                                                                                                                                                                                         |
+| `name`                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | name is the full name or company name of the customer                                                                                                                                                                                                              |
+| `parentCustomerExternalId`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | Deprecated: See ParentCustomerID.<br/>parent_customer_external_id is the external ID of the parent customer from your system.<br/>Exactly one of parent_customer_id or parent_customer_external_id may be provided.                                                |
+| `parentCustomerId`                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.<br/>This field is accepted for backward compatibility but no hierarchy validations are enforced.<br/>parent_customer_id is the internal FlexPrice ID of the parent customer. |
+| `skipOnboardingWorkflow`                                                                                                                                                                                                                                           | *boolean*                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                 | skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered<br/>This is used internally when a customer is created via a workflow to prevent infinite loops<br/>Default: false                                              |
+| `taxRateOverrides`                                                                                                                                                                                                                                                 | [models.DtoTaxRateOverride](../../sdk/models/dto-tax-rate-override.md)[]                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | tax_rate_overrides contains tax rate configurations to be linked to this customer                                                                                                                                                                                  |

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

@@ -15,42 +15,44 @@ let value: DtoCreateSubscriptionRequest = {
 
 ## Fields
 
-| Field                                                                                                                                             | Type                                                                                                                                              | Required                                                                                                                                          | Description                                                                                                                                       |
-| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `addons`                                                                                                                                          | [models.DtoAddAddonToSubscriptionRequest](../../sdk/models/dto-add-addon-to-subscription-request.md)[]                                            | :heavy_minus_sign:                                                                                                                                | Addons represents addons to be added to the subscription during creation                                                                          |
-| `billingCadence`                                                                                                                                  | [models.BillingCadence](../../sdk/models/billing-cadence.md)                                                                                      | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `billingCycle`                                                                                                                                    | [models.BillingCycle](../../sdk/models/billing-cycle.md)                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `billingPeriod`                                                                                                                                   | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                        | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `billingPeriodCount`                                                                                                                              | *number*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `collectionMethod`                                                                                                                                | [models.CollectionMethod](../../sdk/models/collection-method.md)                                                                                  | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `commitmentAmount`                                                                                                                                | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | CommitmentAmount is the minimum amount a customer commits to paying for a billing period                                                          |
-| `commitmentDuration`                                                                                                                              | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                        | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `coupons`                                                                                                                                         | *string*[]                                                                                                                                        | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `creditGrants`                                                                                                                                    | [models.DtoCreateCreditGrantRequest](../../sdk/models/dto-create-credit-grant-request.md)[]                                                       | :heavy_minus_sign:                                                                                                                                | Credit grants to be applied when subscription is created                                                                                          |
-| `currency`                                                                                                                                        | *string*                                                                                                                                          | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `customerId`                                                                                                                                      | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | customer_id is the flexprice customer id<br/>and it is prioritized over external_customer_id in case both are provided.                           |
-| `customerTimezone`                                                                                                                                | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | Timezone of the customer.<br/>If not set, the default value is UTC.                                                                               |
-| `enableTrueUp`                                                                                                                                    | *boolean*                                                                                                                                         | :heavy_minus_sign:                                                                                                                                | Enable Commitment True Up Fee                                                                                                                     |
-| `endDate`                                                                                                                                         | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `externalCustomerId`                                                                                                                              | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | external_customer_id is the customer id in your DB<br/>and must be same as what you provided as external_id while creating the customer in flexprice. |
-| `gatewayPaymentMethodId`                                                                                                                          | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `invoiceBilling`                                                                                                                                  | [models.InvoiceBilling](../../sdk/models/invoice-billing.md)                                                                                      | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `lineItemCommitments`                                                                                                                             | Record<string, [models.DtoLineItemCommitmentConfig](../../sdk/models/dto-line-item-commitment-config.md)>                                         | :heavy_minus_sign:                                                                                                                                | LineItemCommitments allows setting commitment configuration per line item (keyed by price_id)                                                     |
-| `lineItemCoupons`                                                                                                                                 | Record<string, *string*[]>                                                                                                                        | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `lineItems`                                                                                                                                       | [models.DtoCreateSubscriptionLineItemRequest](../../sdk/models/dto-create-subscription-line-item-request.md)[]                                    | :heavy_minus_sign:                                                                                                                                | LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices                                       |
-| `lookupKey`                                                                                                                                       | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `metadata`                                                                                                                                        | Record<string, *string*>                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `overageFactor`                                                                                                                                   | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | OverageFactor is a multiplier applied to usage beyond the commitment amount                                                                       |
-| `overrideEntitlements`                                                                                                                            | [models.DtoOverrideEntitlementRequest](../../sdk/models/dto-override-entitlement-request.md)[]                                                    | :heavy_minus_sign:                                                                                                                                | OverrideEntitlements allows customizing specific entitlements for this subscription                                                               |
-| `overrideLineItems`                                                                                                                               | [models.DtoOverrideLineItemRequest](../../sdk/models/dto-override-line-item-request.md)[]                                                         | :heavy_minus_sign:                                                                                                                                | OverrideLineItems allows customizing specific prices for this subscription                                                                        |
-| `parentSubscriptionId`                                                                                                                            | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)                                         |
-| `paymentBehavior`                                                                                                                                 | [models.PaymentBehavior](../../sdk/models/payment-behavior.md)                                                                                    | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `paymentTerms`                                                                                                                                    | [models.PaymentTerms](../../sdk/models/payment-terms.md)                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `phases`                                                                                                                                          | [models.DtoSubscriptionPhaseCreateRequest](../../sdk/models/dto-subscription-phase-create-request.md)[]                                           | :heavy_minus_sign:                                                                                                                                | Phases represents subscription phases to be created with the subscription                                                                         |
-| `planId`                                                                                                                                          | *string*                                                                                                                                          | :heavy_check_mark:                                                                                                                                | N/A                                                                                                                                               |
-| `prorationBehavior`                                                                                                                               | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                                                                | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `startDate`                                                                                                                                       | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `subscriptionStatus`                                                                                                                              | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                                                                              | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `taxRateOverrides`                                                                                                                                | [models.DtoTaxRateOverride](../../sdk/models/dto-tax-rate-override.md)[]                                                                          | :heavy_minus_sign:                                                                                                                                | tax_rate_overrides is the tax rate overrides	to be applied to the subscription                                                                    |
-| `trialEnd`                                                                                                                                        | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
-| `trialStart`                                                                                                                                      | *string*                                                                                                                                          | :heavy_minus_sign:                                                                                                                                | N/A                                                                                                                                               |
+| Field                                                                                                                                                                                                                                             | Type                                                                                                                                                                                                                                              | Required                                                                                                                                                                                                                                          | Description                                                                                                                                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `addons`                                                                                                                                                                                                                                          | [models.DtoAddAddonToSubscriptionRequest](../../sdk/models/dto-add-addon-to-subscription-request.md)[]                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                | Addons represents addons to be added to the subscription during creation                                                                                                                                                                          |
+| `billingCadence`                                                                                                                                                                                                                                  | [models.BillingCadence](../../sdk/models/billing-cadence.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `billingCycle`                                                                                                                                                                                                                                    | [models.BillingCycle](../../sdk/models/billing-cycle.md)                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `billingPeriod`                                                                                                                                                                                                                                   | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `billingPeriodCount`                                                                                                                                                                                                                              | *number*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `collectionMethod`                                                                                                                                                                                                                                | [models.CollectionMethod](../../sdk/models/collection-method.md)                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `commitmentAmount`                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | CommitmentAmount is the minimum amount a customer commits to paying for a billing period                                                                                                                                                          |
+| `commitmentDuration`                                                                                                                                                                                                                              | [models.BillingPeriod](../../sdk/models/billing-period.md)                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `coupons`                                                                                                                                                                                                                                         | *string*[]                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `creditGrants`                                                                                                                                                                                                                                    | [models.DtoCreateCreditGrantRequest](../../sdk/models/dto-create-credit-grant-request.md)[]                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                | Credit grants to be applied when subscription is created                                                                                                                                                                                          |
+| `currency`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `customerId`                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | customer_id is the flexprice customer id<br/>and it is prioritized over external_customer_id in case both are provided.                                                                                                                           |
+| `customerTimezone`                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | Timezone of the customer.<br/>If not set, the default value is UTC.                                                                                                                                                                               |
+| `enableTrueUp`                                                                                                                                                                                                                                    | *boolean*                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                | Enable Commitment True Up Fee                                                                                                                                                                                                                     |
+| `endDate`                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `externalCustomerId`                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | external_customer_id is the customer id in your DB<br/>and must be same as what you provided as external_id while creating the customer in flexprice.                                                                                             |
+| `gatewayPaymentMethodId`                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `invoiceBilling`                                                                                                                                                                                                                                  | [models.InvoiceBilling](../../sdk/models/invoice-billing.md)                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `invoicingCustomerExternalId`                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | invoicing_customer_external_id is the external ID of the customer to use for invoicing.<br/>Resolved internally to an internal customer ID via external ID lookup.<br/>Mutually exclusive with invoicing_customer_id.                             |
+| `invoicingCustomerId`                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | invoicing_customer_id is the FlexPrice customer ID to use for invoicing.<br/>This can differ from the subscription customer (e.g., a billing entity invoicing on behalf of another customer).<br/>Mutually exclusive with invoicing_customer_external_id. |
+| `lineItemCommitments`                                                                                                                                                                                                                             | Record<string, [models.DtoLineItemCommitmentConfig](../../sdk/models/dto-line-item-commitment-config.md)>                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                | LineItemCommitments allows setting commitment configuration per line item (keyed by price_id)                                                                                                                                                     |
+| `lineItemCoupons`                                                                                                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `lineItems`                                                                                                                                                                                                                                       | [models.DtoCreateSubscriptionLineItemRequest](../../sdk/models/dto-create-subscription-line-item-request.md)[]                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                | LineItems are extra line items to add at creation (each with price_id or price), in addition to plan prices                                                                                                                                       |
+| `lookupKey`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `metadata`                                                                                                                                                                                                                                        | Record<string, *string*>                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `overageFactor`                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | OverageFactor is a multiplier applied to usage beyond the commitment amount                                                                                                                                                                       |
+| `overrideEntitlements`                                                                                                                                                                                                                            | [models.DtoOverrideEntitlementRequest](../../sdk/models/dto-override-entitlement-request.md)[]                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                | OverrideEntitlements allows customizing specific entitlements for this subscription                                                                                                                                                               |
+| `overrideLineItems`                                                                                                                                                                                                                               | [models.DtoOverrideLineItemRequest](../../sdk/models/dto-override-line-item-request.md)[]                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                | OverrideLineItems allows customizing specific prices for this subscription                                                                                                                                                                        |
+| `parentSubscriptionId`                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | ParentSubscriptionID is the parent subscription ID for hierarchy (e.g. child subscription under a parent)                                                                                                                                         |
+| `paymentBehavior`                                                                                                                                                                                                                                 | [models.PaymentBehavior](../../sdk/models/payment-behavior.md)                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `paymentTerms`                                                                                                                                                                                                                                    | [models.PaymentTerms](../../sdk/models/payment-terms.md)                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `phases`                                                                                                                                                                                                                                          | [models.DtoSubscriptionPhaseCreateRequest](../../sdk/models/dto-subscription-phase-create-request.md)[]                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                | Phases represents subscription phases to be created with the subscription                                                                                                                                                                         |
+| `planId`                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `prorationBehavior`                                                                                                                                                                                                                               | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `startDate`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `subscriptionStatus`                                                                                                                                                                                                                              | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `taxRateOverrides`                                                                                                                                                                                                                                | [models.DtoTaxRateOverride](../../sdk/models/dto-tax-rate-override.md)[]                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | tax_rate_overrides is the tax rate overrides	to be applied to the subscription                                                                                                                                                                    |
+| `trialEnd`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |
+| `trialStart`                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                | N/A                                                                                                                                                                                                                                               |

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

@@ -12,25 +12,25 @@ let value: DtoCustomerResponse = {};
 
 ## Fields
 
-| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| `addressCity`                                                                | *string*                                                                     | :heavy_minus_sign:                                                           | AddressCity is the city of the customer's address                            |
-| `addressCountry`                                                             | *string*                                                                     | :heavy_minus_sign:                                                           | AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2) |
-| `addressLine1`                                                               | *string*                                                                     | :heavy_minus_sign:                                                           | AddressLine1 is the first line of the customer's address                     |
-| `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                          |
-| `createdAt`                                                                  | *string*                                                                     | :heavy_minus_sign:                                                           | N/A                                                                          |
-| `createdBy`                                                                  | *string*                                                                     | :heavy_minus_sign:                                                           | N/A                                                                          |
-| `email`                                                                      | *string*                                                                     | :heavy_minus_sign:                                                           | Email is the email of the customer                                           |
-| `environmentId`                                                              | *string*                                                                     | :heavy_minus_sign:                                                           | EnvironmentID is the environment identifier for the customer                 |
-| `externalId`                                                                 | *string*                                                                     | :heavy_minus_sign:                                                           | ExternalID is the external identifier for the customer                       |
-| `id`                                                                         | *string*                                                                     | :heavy_minus_sign:                                                           | ID is the unique identifier for the customer                                 |
-| `metadata`                                                                   | Record<string, *string*>                                                     | :heavy_minus_sign:                                                           | Metadata                                                                     |
-| `name`                                                                       | *string*                                                                     | :heavy_minus_sign:                                                           | Name is the name of the customer                                             |
-| `parentCustomer`                                                             | [models.DtoCustomerResponse](../../sdk/models/dto-customer-response.md)      | :heavy_minus_sign:                                                           | Customer response object containing all customer information                 |
-| `parentCustomerId`                                                           | *string*                                                                     | :heavy_minus_sign:                                                           | ParentCustomerID is the parent customer identifier for the customer          |
-| `status`                                                                     | [models.Status](../../sdk/models/status.md)                                  | :heavy_minus_sign:                                                           | N/A                                                                          |
-| `tenantId`                                                                   | *string*                                                                     | :heavy_minus_sign:                                                           | N/A                                                                          |
-| `updatedAt`                                                                  | *string*                                                                     | :heavy_minus_sign:                                                           | N/A                                                                          |
-| `updatedBy`                                                                  | *string*                                                                     | :heavy_minus_sign:                                                           | N/A                                                                          |
+| Field                                                                                                                                                                                                                                                         | Type                                                                                                                                                                                                                                                          | Required                                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                   |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `addressCity`                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | AddressCity is the city of the customer's address                                                                                                                                                                                                             |
+| `addressCountry`                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)                                                                                                                                                                                  |
+| `addressLine1`                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | AddressLine1 is the first line of the customer's address                                                                                                                                                                                                      |
+| `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                                                                                                                                                                                                           |
+| `createdAt`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | N/A                                                                                                                                                                                                                                                           |
+| `createdBy`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | N/A                                                                                                                                                                                                                                                           |
+| `email`                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Email is the email of the customer                                                                                                                                                                                                                            |
+| `environmentId`                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | EnvironmentID is the environment identifier for the customer                                                                                                                                                                                                  |
+| `externalId`                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | ExternalID is the external identifier for the customer                                                                                                                                                                                                        |
+| `id`                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | ID is the unique identifier for the customer                                                                                                                                                                                                                  |
+| `metadata`                                                                                                                                                                                                                                                    | Record<string, *string*>                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Metadata                                                                                                                                                                                                                                                      |
+| `name`                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Name is the name of the customer                                                                                                                                                                                                                              |
+| `parentCustomer`                                                                                                                                                                                                                                              | [models.DtoCustomerResponse](../../sdk/models/dto-customer-response.md)                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                            | Customer response object containing all customer information                                                                                                                                                                                                  |
+| `parentCustomerId`                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | Deprecated: Customer parent hierarchy is deprecated in favor of subscription-level hierarchy.<br/>Retained for backward compatibility; no hierarchy rules are enforced at the service layer.<br/>ParentCustomerID is the parent customer identifier for the customer. |
+| `status`                                                                                                                                                                                                                                                      | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                            | N/A                                                                                                                                                                                                                                                           |
+| `tenantId`                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | N/A                                                                                                                                                                                                                                                           |
+| `updatedAt`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | N/A                                                                                                                                                                                                                                                           |
+| `updatedBy`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                            | N/A                                                                                                                                                                                                                                                           |