@polar-sh/sdk 1.0.1 → 1.0.2

package/dist/{models-772bIFO1.d.mts → models-MQGPXSzo.d.mts}

@@ -1275,7 +1275,7 @@ interface BenefitCustom {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -1586,7 +1586,7 @@ interface BenefitDiscord {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -1927,7 +1927,7 @@ interface BenefitDownloadables {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -2182,7 +2182,7 @@ interface BenefitFeatureFlag {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -2417,7 +2417,7 @@ interface BenefitGitHubRepository {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -3634,7 +3634,7 @@ interface BenefitLicenseKeys {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -3920,7 +3920,7 @@ interface BenefitMeterCredit {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -4272,7 +4272,7 @@ interface BenefitSlackSharedChannel {
    */
   metadata: MetadataOutputType;
   /**
-   * visibility
+   * The visibility of the benefit in the customer portal.
    */
   visibility: BenefitVisibility;
   /**
@@ -4535,7 +4535,7 @@ interface BenefitSubscriberOrganization {
    */
   avatar_url: string | null;
   /**
-   * proration_behavior
+   * Proration behavior applied when customer updates their subscription from the portal.
    */
   proration_behavior: SubscriptionProrationBehavior;
   /**
@@ -4634,11 +4634,11 @@ interface CardPayment {
    */
   id: string;
   /**
-   * processor
+   * The payment processor.
    */
   processor: PaymentProcessor;
   /**
-   * status
+   * The payment status.
    */
   status: PaymentStatus;
   /**
@@ -4682,7 +4682,7 @@ interface CardPayment {
    */
   processor_metadata?: Record<string, unknown>;
   /**
-   * method_metadata
+   * Additional metadata for the card payment method.
    */
   method_metadata: CardPaymentMetadata;
 }
@@ -4720,12 +4720,20 @@ interface Checkout {
    */
   custom_field_data?: Record<string, string | number | boolean | null>;
   /**
-   * payment_processor
+   * Payment processor used.
    */
   payment_processor: PaymentProcessor;
   /**
-   * status
-   */
+     *
+          Status of the checkout session.
+  
+          - Open: the checkout session was opened.
+          - Expired: the checkout session was expired and is no more accessible.
+          - Confirmed: the user on the checkout session clicked Pay. This is not indicative of the payment's success status.
+          - Failed: the checkout definitely failed for technical reasons and cannot be retried. In most cases, this state is never reached.
+          - Succeeded: the payment on the checkout was performed successfully.
+          
+     */
   status: CheckoutStatus;
   /**
    * Client secret used to update and complete the checkout session from the client.
@@ -4908,7 +4916,7 @@ interface Checkout {
    */
   payment_processor_metadata: Record<string, string>;
   /**
-   * billing_address_fields
+   * Determine which billing address fields should be disabled, optional or required in the checkout form.
    */
   billing_address_fields: CheckoutBillingAddressFields;
   /**
@@ -5472,7 +5480,7 @@ interface CheckoutLink {
    */
   metadata: MetadataOutputType;
   /**
-   * payment_processor
+   * Payment processor used.
    */
   payment_processor: PaymentProcessor;
   /**
@@ -5768,7 +5776,7 @@ interface CheckoutLinkProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -5917,7 +5925,7 @@ interface CheckoutOrganization {
    */
   avatar_url: string | null;
   /**
-   * proration_behavior
+   * Proration behavior applied when customer updates their subscription from the portal.
    */
   proration_behavior: SubscriptionProrationBehavior;
   /**
@@ -5958,7 +5966,7 @@ interface CheckoutProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -6023,12 +6031,20 @@ interface CheckoutPublic {
    */
   custom_field_data?: Record<string, string | number | boolean | null>;
   /**
-   * payment_processor
+   * Payment processor used.
    */
   payment_processor: PaymentProcessor;
   /**
-   * status
-   */
+     *
+          Status of the checkout session.
+  
+          - Open: the checkout session was opened.
+          - Expired: the checkout session was expired and is no more accessible.
+          - Confirmed: the user on the checkout session clicked Pay. This is not indicative of the payment's success status.
+          - Failed: the checkout definitely failed for technical reasons and cannot be retried. In most cases, this state is never reached.
+          - Succeeded: the payment on the checkout was performed successfully.
+          
+     */
   status: CheckoutStatus;
   /**
    * Client secret used to update and complete the checkout session from the client.
@@ -6211,7 +6227,7 @@ interface CheckoutPublic {
    */
   payment_processor_metadata: Record<string, string>;
   /**
-   * billing_address_fields
+   * Determine which billing address fields should be disabled, optional or required in the checkout form.
    */
   billing_address_fields: CheckoutBillingAddressFields;
   /**
@@ -6267,7 +6283,7 @@ interface CheckoutPublicConfirmed {
    */
   custom_field_data?: Record<string, string | number | boolean | null>;
   /**
-   * payment_processor
+   * Payment processor used.
    */
   payment_processor: PaymentProcessor;
   /**
@@ -6455,7 +6471,7 @@ interface CheckoutPublicConfirmed {
    */
   payment_processor_metadata: Record<string, string>;
   /**
-   * billing_address_fields
+   * Determine which billing address fields should be disabled, optional or required in the checkout form.
    */
   billing_address_fields: CheckoutBillingAddressFields;
   /**
@@ -8561,11 +8577,11 @@ interface CustomerMeter {
    */
   balance: number;
   /**
-   * customer
+   * The customer associated with this meter.
    */
   customer: Customer;
   /**
-   * meter
+   * The meter associated with this customer.
    */
   meter: Meter;
 }
@@ -8740,7 +8756,7 @@ interface CustomerOrderConfirmPayment {
    */
   payment_method_id?: string | null;
   /**
-   * payment_processor
+   * Payment processor used.
    */
   payment_processor?: PaymentProcessor;
 }
@@ -8816,7 +8832,7 @@ interface CustomerOrderProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -8898,7 +8914,7 @@ interface CustomerOrderSubscription {
    */
   currency: string;
   /**
-   * recurring_interval
+   * The interval at which the subscription recurs.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -8906,7 +8922,7 @@ interface CustomerOrderSubscription {
    */
   recurring_interval_count: number;
   /**
-   * status
+   * The status of the subscription.
    */
   status: SubscriptionStatus;
   /**
@@ -9044,7 +9060,7 @@ interface CustomerOrganization {
    */
   avatar_url: string | null;
   /**
-   * proration_behavior
+   * Proration behavior applied when customer updates their subscription from the portal.
    */
   proration_behavior: SubscriptionProrationBehavior;
   /**
@@ -9052,11 +9068,11 @@ interface CustomerOrganization {
    */
   allow_customer_updates: boolean;
   /**
-   * customer_portal_settings
+   * Settings related to the customer portal
    */
   customer_portal_settings: OrganizationCustomerPortalSettings;
   /**
-   * organization_features
+   * Feature flags for the customer portal.
    */
   organization_features?: CustomerOrganizationFeatureSettings;
 }
@@ -9361,7 +9377,7 @@ interface CustomerPortalMember {
    */
   name: string | null;
   /**
-   * role
+   * The role of the member within the team.
    */
   role: MemberRole;
 }
@@ -9378,7 +9394,7 @@ interface CustomerPortalMemberCreate {
    */
   name?: string | null;
   /**
-   * role
+   * The role for the new member. Defaults to 'member'.
    */
   role?: MemberRole;
 }
@@ -9471,7 +9487,7 @@ interface CustomerProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -9540,7 +9556,7 @@ interface CustomerSeat {
    */
   order_id: string | null;
   /**
-   * status
+   * Status of the seat
    */
   status: SeatStatus;
   /**
@@ -9630,7 +9646,7 @@ interface CustomerSeatAssign {
  */
 interface CustomerSeatClaimResponse {
   /**
-   * seat
+   * The claimed seat
    */
   seat: CustomerSeat;
   /**
@@ -9746,11 +9762,11 @@ interface CustomerStateBenefitGrant {
    */
   benefit_id: string;
   /**
-   * benefit_type
+   * The type of the benefit concerned by this grant.
    */
   benefit_type: BenefitType;
   /**
-   * benefit_metadata
+   * The metadata of the benefit concerned by this grant.
    */
   benefit_metadata: MetadataOutputType;
   /**
@@ -9920,7 +9936,7 @@ interface CustomerStateSubscription {
    */
   currency: string;
   /**
-   * recurring_interval
+   * The interval at which the subscription recurs.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -10126,7 +10142,7 @@ interface CustomerSubscription {
    */
   currency: string;
   /**
-   * recurring_interval
+   * The interval at which the subscription recurs.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -10134,7 +10150,7 @@ interface CustomerSubscription {
    */
   recurring_interval_count: number;
   /**
-   * status
+   * The status of the subscription.
    */
   status: SubscriptionStatus;
   /**
@@ -10380,7 +10396,7 @@ interface CustomerSubscriptionProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -10892,7 +10908,7 @@ interface DiscountFixedCreate {
    */
   type?: "fixed";
   /**
-   * duration
+   * For subscriptions, determines if the discount should be applied once on the first invoice, forever, or for a certain number of months determined by `duration_in_months`.
    */
   duration: DiscountDuration;
   /**
@@ -11281,7 +11297,7 @@ interface DiscountPercentageCreate {
    */
   type?: "percentage";
   /**
-   * duration
+   * For subscriptions, determines if the discount should be applied once on the first invoice, forever, or for a certain number of months determined by `duration_in_months`.
    */
   duration: DiscountDuration;
   /**
@@ -11615,7 +11631,7 @@ interface DiscountProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -11754,7 +11770,7 @@ interface Dispute {
    */
   id: string;
   /**
-   * status
+   * Status of the dispute. `prevented` means we issued a refund before the dispute was escalated, avoiding any fees.
    */
   status: DisputeStatus;
   /**
@@ -11798,7 +11814,7 @@ interface Dispute {
    */
   payment_id: string;
   /**
-   * customer
+   * The customer who was charged for the disputed payment.
    */
   customer: DisputeCustomer;
   /**
@@ -11852,7 +11868,7 @@ interface DisputeCustomer {
    */
   email_verified: boolean;
   /**
-   * type
+   * The type of customer: 'individual' for single users, 'team' for customers with multiple members.
    */
   type: CustomerType;
   /**
@@ -12061,8 +12077,18 @@ interface EventCreateCustomer {
    */
   parent_id?: string | null;
   /**
-   * metadata
-   */
+     * Key-value object allowing you to store additional information about the event. Some keys like `_llm` are structured data that are handled specially by Polar.
+  
+  The key must be a string with a maximum length of **40 characters**.
+  The value must be either:
+  
+  * A string with a maximum length of **500 characters**
+  * An integer
+  * A floating-point number
+  * A boolean
+  
+  You can store up to **50 key-value pairs**.
+     */
   metadata?: EventMetadataInput;
   /**
    * ID of the customer in your Polar organization associated with the event.
@@ -12098,8 +12124,18 @@ interface EventCreateExternalCustomer {
    */
   parent_id?: string | null;
   /**
-   * metadata
-   */
+     * Key-value object allowing you to store additional information about the event. Some keys like `_llm` are structured data that are handled specially by Polar.
+  
+  The key must be a string with a maximum length of **40 characters**.
+  The value must be either:
+  
+  * A string with a maximum length of **500 characters**
+  * An integer
+  * A floating-point number
+  * A boolean
+  
+  You can store up to **50 key-value pairs**.
+     */
   metadata?: EventMetadataInput;
   /**
    * ID of the customer in your system associated with the event.
@@ -12151,7 +12187,7 @@ interface EventName {
    */
   label: string;
   /**
-   * source
+   * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
    */
   source: EventSource;
   /**
@@ -12246,7 +12282,7 @@ interface EventTypeWithStats {
    */
   organization_id: string;
   /**
-   * source
+   * The source of the events (system or user).
    */
   source: EventSource;
   /**
@@ -12523,11 +12559,11 @@ interface GenericPayment {
    */
   id: string;
   /**
-   * processor
+   * The payment processor.
    */
   processor: PaymentProcessor;
   /**
-   * status
+   * The payment status.
    */
   status: PaymentStatus;
   /**
@@ -12728,11 +12764,11 @@ interface KrCardPayment {
    */
   id: string;
   /**
-   * processor
+   * The payment processor.
    */
   processor: PaymentProcessor;
   /**
-   * status
+   * The payment status.
    */
   status: PaymentStatus;
   /**
@@ -12776,7 +12812,7 @@ interface KrCardPayment {
    */
   processor_metadata?: Record<string, unknown>;
   /**
-   * method_metadata
+   * Additional metadata for the South Korean card payment method.
    */
   method_metadata: KrCardPaymentMetadata;
 }
@@ -12848,7 +12884,7 @@ interface LegacyRecurringProductPriceCustom {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -12876,7 +12912,7 @@ interface LegacyRecurringProductPriceCustom {
    */
   type: "recurring";
   /**
-   * recurring_interval
+   * The recurring interval of the price.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -12914,7 +12950,7 @@ interface LegacyRecurringProductPriceFixed {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -12942,7 +12978,7 @@ interface LegacyRecurringProductPriceFixed {
    */
   type: "recurring";
   /**
-   * recurring_interval
+   * The recurring interval of the price.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -13127,7 +13163,7 @@ interface LicenseKeyCustomer {
    */
   email_verified: boolean;
   /**
-   * type
+   * The type of customer: 'individual' for single users, 'team' for customers with multiple members.
    */
   type: CustomerType;
   /**
@@ -13899,7 +13935,7 @@ interface Member {
    */
   external_id: string | null;
   /**
-   * role
+   * The role of the member within the customer.
    */
   role: MemberRole;
 }
@@ -13989,7 +14025,7 @@ interface Meter {
    */
   name: string;
   /**
-   * unit
+   * The unit of the meter.
    */
   unit: MeterUnit;
   /**
@@ -14001,7 +14037,7 @@ interface Meter {
    */
   custom_multiplier?: number | null;
   /**
-   * filter
+   * The filter to apply on events that'll be used to calculate the meter.
    */
   filter: Filter;
   /**
@@ -14040,7 +14076,7 @@ interface MeterCreate {
    */
   name: string;
   /**
-   * unit
+   * The unit of the meter.
    */
   unit?: MeterUnit;
   /**
@@ -14052,7 +14088,7 @@ interface MeterCreate {
    */
   custom_multiplier?: number | null;
   /**
-   * filter
+   * The filter to apply on events that'll be used to calculate the meter.
    */
   filter: Filter;
   /**
@@ -14298,7 +14334,7 @@ interface Metric {
    */
   display_name: string;
   /**
-   * type
+   * Type of the metric, useful to know the unit or format of the value.
    */
   type: MetricType;
 }
@@ -14833,23 +14869,23 @@ interface MetricsIntervalLimit {
  */
 interface MetricsIntervalsLimits {
   /**
-   * hour
+   * Limits for the hour interval.
    */
   hour: MetricsIntervalLimit;
   /**
-   * day
+   * Limits for the day interval.
    */
   day: MetricsIntervalLimit;
   /**
-   * week
+   * Limits for the week interval.
    */
   week: MetricsIntervalLimit;
   /**
-   * month
+   * Limits for the month interval.
    */
   month: MetricsIntervalLimit;
   /**
-   * year
+   * Limits for the year interval.
    */
   year: MetricsIntervalLimit;
 }
@@ -14862,7 +14898,7 @@ interface MetricsLimits {
    */
   min_date: string;
   /**
-   * intervals
+   * Limits for each interval.
    */
   intervals: MetricsIntervalsLimits;
 }
@@ -14875,11 +14911,11 @@ interface MetricsResponse {
    */
   periods: MetricPeriod[];
   /**
-   * totals
+   * Totals for the whole selected period.
    */
   totals: MetricsTotals;
   /**
-   * metrics
+   * Information about the returned metrics.
    */
   metrics: Metrics;
 }
@@ -15552,7 +15588,7 @@ interface OrderCustomer {
    */
   email_verified: boolean;
   /**
-   * type
+   * The type of customer: 'individual' for single users, 'team' for customers with multiple members.
    */
   type: CustomerType;
   /**
@@ -15857,7 +15893,7 @@ interface OrderProduct {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -16005,7 +16041,7 @@ interface OrderSubscription {
    */
   currency: string;
   /**
-   * recurring_interval
+   * The interval at which the subscription recurs.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -16013,7 +16049,7 @@ interface OrderSubscription {
    */
   recurring_interval_count: number;
   /**
-   * status
+   * The status of the subscription.
    */
   status: SubscriptionStatus;
   /**
@@ -16307,7 +16343,7 @@ interface Organization {
    */
   avatar_url: string | null;
   /**
-   * proration_behavior
+   * Proration behavior applied when customer updates their subscription from the portal.
    */
   proration_behavior: SubscriptionProrationBehavior;
   /**
@@ -16327,7 +16363,7 @@ interface Organization {
    */
   socials: OrganizationSocialLink[];
   /**
-   * status
+   * Current organization status
    */
   status: OrganizationStatus;
   /**
@@ -16347,7 +16383,7 @@ interface Organization {
    */
   default_presentment_currency: string;
   /**
-   * default_tax_behavior
+   * Default tax behavior applied on products.
    */
   default_tax_behavior: TaxBehaviorOption;
   /**
@@ -16355,19 +16391,19 @@ interface Organization {
    */
   feature_settings: OrganizationFeatureSettings | null;
   /**
-   * subscription_settings
+   * Settings related to subscriptions management
    */
   subscription_settings: OrganizationSubscriptionSettings;
   /**
-   * customer_email_settings
+   * Settings related to customer emails
    */
   customer_email_settings: OrganizationCustomerEmailSettings;
   /**
-   * customer_portal_settings
+   * Settings related to the customer portal
    */
   customer_portal_settings: OrganizationCustomerPortalSettings;
   /**
-   * dispute_settings
+   * Settings related to disputes
    */
   dispute_settings: OrganizationDisputeSettings;
   /**
@@ -16387,7 +16423,7 @@ interface Organization {
    */
   payout_account_id: string | null;
   /**
-   * capabilities
+   * Capabilities currently granted to the organization.
    */
   capabilities: OrganizationCapabilities;
 }
@@ -16600,11 +16636,11 @@ interface OrganizationCreate {
    */
   customer_portal_settings?: OrganizationCustomerPortalSettings | null;
   /**
-   * default_presentment_currency
+   * Default presentment currency for the organization
    */
   default_presentment_currency?: PresentmentCurrency;
   /**
-   * default_tax_behavior
+   * Default tax behavior applied on products.
    */
   default_tax_behavior?: TaxBehaviorOption;
 }
@@ -16865,7 +16901,7 @@ interface OrganizationNotReadyForPayments {
  */
 interface OrganizationSocialLink {
   /**
-   * platform
+   * The social platform of the URL
    */
   platform: OrganizationSocialPlatforms;
   /**
@@ -17325,7 +17361,7 @@ interface Product {
    */
   description: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility: ProductVisibility;
   /**
@@ -17417,7 +17453,7 @@ interface ProductCreateOneTime {
    */
   description?: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility?: ProductVisibility;
   /**
@@ -17472,7 +17508,7 @@ interface ProductCreateRecurring {
    */
   description?: string | null;
   /**
-   * visibility
+   * The visibility of the product.
    */
   visibility?: ProductVisibility;
   /**
@@ -17500,7 +17536,7 @@ interface ProductCreateRecurring {
    */
   trial_interval_count?: number | null;
   /**
-   * recurring_interval
+   * The recurring interval of the product.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -17656,7 +17692,7 @@ interface ProductPriceCustom {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -17701,7 +17737,7 @@ interface ProductPriceCustomCreate {
    */
   amount_type: "custom";
   /**
-   * price_currency
+   * The currency in which the customer will be charged.
    */
   price_currency?: PresentmentCurrency;
   /**
@@ -18008,7 +18044,7 @@ interface ProductPriceFixed {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -18045,7 +18081,7 @@ interface ProductPriceFixedCreate {
    */
   amount_type: "fixed";
   /**
-   * price_currency
+   * The currency in which the customer will be charged.
    */
   price_currency?: PresentmentCurrency;
   /**
@@ -18198,7 +18234,7 @@ interface ProductPriceMeter {
    */
   name: string;
   /**
-   * unit
+   * The unit of the meter.
    */
   unit: MeterUnit;
   /**
@@ -18227,7 +18263,7 @@ interface ProductPriceMeteredTiers {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -18259,11 +18295,11 @@ interface ProductPriceMeteredTiers {
    */
   meter_id: string;
   /**
-   * meter
+   * The meter associated to the price.
    */
   meter: ProductPriceMeter;
   /**
-   * tiers
+   * The pricing tiers based on consumed units.
    */
   tiers: Tiers;
 }
@@ -18276,7 +18312,7 @@ interface ProductPriceMeteredTiersCreate {
    */
   amount_type: "metered_tiers";
   /**
-   * price_currency
+   * The currency in which the customer will be charged.
    */
   price_currency?: PresentmentCurrency;
   /**
@@ -18288,7 +18324,7 @@ interface ProductPriceMeteredTiersCreate {
    */
   meter_id: string;
   /**
-   * tiers
+   * Tiered pricing based on consumed units.
    */
   tiers: TiersInput;
   /**
@@ -18313,7 +18349,7 @@ interface ProductPriceMeteredUnit {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -18345,7 +18381,7 @@ interface ProductPriceMeteredUnit {
    */
   meter_id: string;
   /**
-   * meter
+   * The meter associated to the price.
    */
   meter: ProductPriceMeter;
   /**
@@ -18362,7 +18398,7 @@ interface ProductPriceMeteredUnitCreate {
    */
   amount_type: "metered_unit";
   /**
-   * price_currency
+   * The currency in which the customer will be charged.
    */
   price_currency?: PresentmentCurrency;
   /**
@@ -18399,7 +18435,7 @@ interface ProductPriceSeatBased {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -18423,7 +18459,7 @@ interface ProductPriceSeatBased {
    */
   product_id: string;
   /**
-   * seat_tiers
+   * Tiered pricing based on seat quantity
    */
   seat_tiers: ProductPriceSeatTiersOutput;
 }
@@ -18436,7 +18472,7 @@ interface ProductPriceSeatBasedCreate {
    */
   amount_type: "seat_based";
   /**
-   * price_currency
+   * The currency in which the customer will be charged.
    */
   price_currency?: PresentmentCurrency;
   /**
@@ -18444,7 +18480,7 @@ interface ProductPriceSeatBasedCreate {
    */
   tax_behavior?: TaxBehaviorOption | null;
   /**
-   * seat_tiers
+   * Tiered pricing based on seat quantity
    */
   seat_tiers: ProductPriceSeatTiersInput;
 }
@@ -18474,7 +18510,7 @@ The minimum and maximum seat limits are derived from the tiers:
  */
 interface ProductPriceSeatTiersInput {
   /**
-   * seat_tier_type
+   * How tiers are applied. 'volume' prices all seats at the matching tier's rate. 'graduated' prices each tier's range independently.
    */
   seat_tier_type?: SeatTierType;
   /**
@@ -18491,7 +18527,7 @@ The minimum and maximum seat limits are derived from the tiers:
  */
 interface ProductPriceSeatTiersOutput {
   /**
-   * seat_tier_type
+   * How tiers are applied. 'volume' prices all seats at the matching tier's rate. 'graduated' prices each tier's range independently.
    */
   seat_tier_type?: SeatTierType;
   /**
@@ -18525,7 +18561,7 @@ interface ProductPriceUnitBased {
    */
   id: string;
   /**
-   * source
+   * The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.
    */
   source: ProductPriceSource;
   /**
@@ -18549,7 +18585,7 @@ interface ProductPriceUnitBased {
    */
   product_id: string;
   /**
-   * tiers
+   * Tiered pricing based on the purchased unit quantity.
    */
   tiers: Tiers;
   /**
@@ -18575,7 +18611,7 @@ interface ProductPriceUnitBasedCreate {
    */
   amount_type: "unit_based";
   /**
-   * price_currency
+   * The currency in which the customer will be charged.
    */
   price_currency?: PresentmentCurrency;
   /**
@@ -18583,7 +18619,7 @@ interface ProductPriceUnitBasedCreate {
    */
   tax_behavior?: TaxBehaviorOption | null;
   /**
-   * tiers
+   * Tiered pricing based on the purchased unit quantity.
    */
   tiers: TiersInput;
   /**
@@ -18798,7 +18834,7 @@ interface RefundDispute {
    */
   id: string;
   /**
-   * status
+   * Status of the dispute. `prevented` means we issued a refund before the dispute was escalated, avoiding any fees.
    */
   status: DisputeStatus;
   /**
@@ -19203,7 +19239,7 @@ interface Subscription {
    */
   currency: string;
   /**
-   * recurring_interval
+   * The interval at which the subscription recurs.
    */
   recurring_interval: RecurringInterval;
   /**
@@ -19211,7 +19247,7 @@ interface Subscription {
    */
   recurring_interval_count: number;
   /**
-   * status
+   * The status of the subscription.
    */
   status: SubscriptionStatus;
   /**
@@ -19751,7 +19787,7 @@ interface SubscriptionCustomer {
    */
   email_verified: boolean;
   /**
-   * type
+   * The type of customer: 'individual' for single users, 'team' for customers with multiple members.
    */
   type: CustomerType;
   /**
@@ -19931,7 +19967,7 @@ interface SubscriptionMeter {
    */
   meter_id: string;
   /**
-   * meter
+   * The meter associated with this subscription.
    */
   meter: Meter;
 }
@@ -21733,7 +21769,7 @@ interface WebhookDelivery {
    */
   response: string | null;
   /**
-   * webhook_event
+   * The webhook event sent by this delivery.
    */
   webhook_event: WebhookEvent;
 }
@@ -21766,7 +21802,7 @@ interface WebhookEndpoint {
    */
   api_version: string;
   /**
-   * format
+   * The format of the webhook payload.
    */
   format: WebhookFormat;
   /**
@@ -21807,7 +21843,7 @@ interface WebhookEndpointCreate {
    */
   api_version?: ApiVersion;
   /**
-   * format
+   * The format of the webhook payload.
    */
   format: WebhookFormat;
   /**
@@ -21891,7 +21927,7 @@ interface WebhookEvent {
    */
   payload: string | null;
   /**
-   * type
+   * The type of the webhook event.
    */
   type: WebhookEventType;
   /**
@@ -22021,4 +22057,4 @@ type SubscriptionUpdate = SubscriptionUpdateBase | SubscriptionUpdateSeats | Sub
 type SystemEvent = MeterCreditEvent | MeterResetEvent | BenefitGrantedEvent | BenefitCycledEvent | BenefitUpdatedEvent | BenefitRevokedEvent | SubscriptionCreatedEvent | SubscriptionUpdatedEvent | SubscriptionCycledEvent | SubscriptionCanceledEvent | SubscriptionRevokedEvent | SubscriptionPastDueEvent | SubscriptionReactivatedEvent | SubscriptionReinstatedEvent | SubscriptionPausedEvent | SubscriptionResumedEvent | SubscriptionMigratedEvent | SubscriptionUncanceledEvent | SubscriptionProductUpdatedEvent | SubscriptionSeatsUpdatedEvent | SubscriptionUnitsUpdatedEvent | SubscriptionBillingPeriodUpdatedEvent | SubscriptionUpdateClearedEvent | OrderPaidEvent | OrderRefundedEvent | OrderVoidedEvent | OrderUnvoidedEvent | CheckoutCreatedEvent | CustomerCreatedEvent | CustomerUpdatedEvent | CustomerDeletedEvent | BalanceOrderEvent | BalanceCreditOrderEvent | BalanceRefundEvent | BalanceRefundReversalEvent | BalanceDisputeEvent | BalanceDisputeReversalEvent;
 //#endregion
 export { CustomerEmailUpdateRequest as $, ListResourceRefund as $n, PaymentNotReady as $r, EventType as $t, CheckoutLinkSortProperty as A, SubscriptionSortProperty as Ai, ListResourceCustomerBenefitGrant as An, OrderInvoice as Ar, CustomerState as At, CustomFieldCreate as B, UserInfoOrganization as Bi, ListResourceDownloadableRead as Bn, OrganizationNotReadyForPayments as Br, DiscountSortProperty as Bt, CannotCreateOrganizationError as C, SeatsList as Ci, ListResourceBenefit as Cn, OAuth2ClientConfiguration as Cr, CustomerSeat as Ct, CheckoutForbiddenError as D, SubscriptionExportColumn as Di, ListResourceCheckoutLink as Dn, OrderCreate as Dr, CustomerSessionCustomerExternalIDCreate as Dt, CheckoutCreate as E, SubscriptionCreateExternalCustomer as Ei, ListResourceCheckout as En, Order as Er, CustomerSession as Et, CheckoutSortProperty as F, TokenResponse as Fi, ListResourceCustomerPortalMember as Fn, OrderSortProperty as Fr, CustomerUpdateExternalID as Ft, CustomerBenefitGrant as G, WebhookEndpointCreate as Gi, ListResourceLicenseKeyRead as Gn, PaymentActionRequired as Gr, DisputeSortProperty as Gt, CustomFieldType as H, ValidatedLicenseKey as Hi, ListResourceEventName as Hn, OrganizationUpdate as Hr, Dispute as Ht, CheckoutStatus as I, Unauthorized as Ii, ListResourceCustomerSubscription as In, OrderStatus as Ir, CustomerWallet as It, CustomerCancellationReason as J, models_d_exports as Ji, ListResourceOrder as Jn, PaymentFailed as Jr, Event as Jt, CustomerBenefitGrantSortProperty as K, WebhookEndpointUpdate as Ki, ListResourceMember as Kn, PaymentAlreadyInProgress as Kr, DisputeStatus as Kt, CheckoutUpdate as L, UpdateSubscriptionPlanNotAllowed as Li, ListResourceCustomerWallet as Ln, OrderUpdate as Lr, CustomerWalletSortProperty as Lt, CheckoutLocked as M, SubscriptionUpdate as Mi, ListResourceCustomerMeter as Mn, OrderNotEligibleForInvoice as Mr, CustomerSubscriptionSortProperty as Mt, CheckoutPublic as N, TimeInterval as Ni, ListResourceCustomerOrder as Nn, OrderNotEligibleForRetry as Nr, CustomerSubscriptionUpdate as Nt, CheckoutLink as O, SubscriptionLocked as Oi, ListResourceCustomField as On, OrderExportColumn as Or, CustomerSessionCustomerIDCreate as Ot, CheckoutPublicConfirmed as P, Timezone as Pi, ListResourceCustomerPaymentMethod as Pn, OrderReceipt as Pr, CustomerUpdate as Pt, CustomerCustomerSession as Q, ListResourceProduct as Qn, PaymentMethodSetupFailed as Qr, EventSource as Qt, CheckoutUpdatePublic as R, UpdateSubscriptionSeatsNotAllowed as Ri, ListResourceDiscount as Rn, Organization as Rr, Discount as Rt, BenefitType as S, SeatClaimInfo as Si, LicenseKeyWithActivations as Sn, NotPermitted as Sr, CustomerPortalMemberUpdate as St, CheckoutConfirmStripe as T, SubscriptionCreateCustomer as Ti, ListResourceBenefitGrant as Tn, OffSessionChargesNotEnabled as Tr, CustomerSeatClaimResponse as Tt, CustomFieldUpdate as U, WebhookDelivery as Ui, ListResourceEventTypeWithStats as Un, PauseResumeNotAllowed as Ur, DisputeAutoAcceptNotEnabled as Ut, CustomFieldSortProperty as V, UserInfoUser as Vi, ListResourceEvent as Vn, OrganizationSortProperty as Vr, DiscountUpdate as Vt, Customer as W, WebhookEndpoint as Wi, ListResourceFileRead as Wn, Payment as Wr, DisputeNotOpenError as Wt, CustomerCustomerMeter as X, ListResourcePayment as Xn, PaymentMethodInUseByActiveSubscription as Xr, EventNamesSortProperty as Xt, CustomerCreate as Y, ListResourceOrganization as Yn, PaymentMethod as Yr, EventName as Yt, CustomerCustomerMeterSortProperty as Z, ListResourcePaymentMethod as Zn, PaymentMethodRequired as Zr, EventSortProperty as Zt, BenefitGrantWebhook as _, RotateNotPermitted as _i, LicenseKeyDeactivate as _n, MetricDashboardSchema as _r, CustomerPaymentMethodCreateResponse as _t, AuthorizeResponseUser as a, ProductBillingType as ai, ExpiredCheckoutError as an, Member as ar, CustomerOrder as at, BenefitSlackSharedChannelUpdate as b, SeatAssign as bi, LicenseKeyUpdate as bn, MetricsResponse as br, CustomerPortalMember as bt, BenefitCreate as c, ProductSortProperty as ci, FileRead as cn, MemberSortProperty as cr, CustomerOrderPaymentConfirmation as ct, BenefitDownloadableFile as d, Refund as di, HTTPValidationError as dn, Meter as dr, CustomerOrderSortProperty as dt, PaymentSortProperty as ei, EventTypeUpdate as en, ListResourceSubscription as er, CustomerEmailUpdateVerifyRequest as et, BenefitDownloadablesUpdate as f, RefundCreate as fi, InactiveSubscription as fn, MeterCreate as fr, CustomerOrderUpdate as ft, BenefitGrantSortProperty as g, RevokeTokenResponse as gi, LicenseKeyActivationRead as gn, MetricDashboardCreate as gr, CustomerPaymentMethodCreate as gt, BenefitGrant as h, ResourceNotFound as hi, LicenseKeyActivationCreated as hn, MeterUpdate as hr, CustomerPaymentMethodConfirm as ht, AuthorizeResponseOrganization as i, ProductBenefitsUpdate as ii, EventsIngestResponse as in, ManualRetryLimitExceeded as ir, CustomerNotReady as it, CheckoutLinkUpdate as j, SubscriptionStatus as ji, ListResourceCustomerCustomerMeter as jn, OrderNotDraft as jr, CustomerSubscription as jt, CheckoutLinkCreate as k, SubscriptionNotScheduledToCancel as ki, ListResourceCustomer as kn, OrderFinalize as kr, CustomerSortProperty as kt, BenefitCustomUpdate as l, ProductUpdate as li, FileUpload as ln, MemberUpdate as lr, CustomerOrderPaymentStatus as lt, BenefitGitHubRepositoryUpdate as m, RefundedAlready as mi, LicenseKeyActivate as mn, MeterSortProperty as mr, CustomerPaymentMethod as mt, AlreadyCanceledSubscription as n, PortalAuthenticatedUser as ni, EventTypesSortProperty as nn, ListResourceWebhookEndpoint as nr, CustomerMeter as nt, BadRequest as o, ProductCreate as oi, FileCreate as on, MemberCreateFromCustomer as or, CustomerOrderConfirmPayment as ot, BenefitFeatureFlagUpdate as p, RefundSortProperty as pi, IntrospectTokenResponse as pn, MeterQuantities as pr, CustomerOrganizationData as pt, CustomerBenefitGrantUpdate as q, WebhookEventType as qi, ListResourceMeter as qn, PaymentError as qr, DownloadableRead as qt, AmbiguousExternalCustomerID as r, Product as ri, EventsIngest as rn, ListResourceWithCursorPaginationEvent as rr, CustomerMeterSortProperty as rt, Benefit as s, ProductNotDeletable as si, FilePatch as sn, MemberRole as sr, CustomerOrderInvoice as st, AggregationFunction as t, PaymentStatus as ti, EventTypeWithStats as tn, ListResourceWebhookDelivery as tr, CustomerEmailUpdateVerifyResponse as tt, BenefitDiscordUpdate as u, ProductVisibility as ui, FileUploadCompleted as un, MetadataQuery as ur, CustomerOrderReceipt as ut, BenefitLicenseKeysUpdate as v, RotatedLicenseKey as vi, LicenseKeyRead as vn, MetricDashboardUpdate as vr, CustomerPortalCustomer as vt, Checkout as w, Subscription as wi, ListResourceBenefitDownloadableFile as wn, OAuth2ClientConfigurationUpdate as wr, CustomerSeatAssign as wt, BenefitSortProperty as x, SeatClaim as xi, LicenseKeyValidate as xn, MissingInvoiceBillingDetails as xr, CustomerPortalMemberCreate as xt, BenefitMeterCreditUpdate as y, SSOEnforcementRequiresConnection as yi, LicenseKeyStatus as yn, MetricsLimits as yr, CustomerPortalCustomerUpdate as yt, CustomField as z, UpdateSubscriptionUnitsNotAllowed as zi, ListResourceDispute as zn, OrganizationCreate as zr, DiscountCreate as zt };
-//# sourceMappingURL=models-772bIFO1.d.mts.map
+//# sourceMappingURL=models-MQGPXSzo.d.mts.map